Skip to content

docs: link the FAQ from Documentation and from Troubleshooting and contact - #126

Merged
lacerbi merged 1 commit into
mainfrom
dev-next
Oct 10, 2026
Merged

lacerbi merged 1 commit into
mainfrom
dev-next

Conversation

@lacerbi

@lacerbi lacerbi commented Oct 10, 2026

Copy link
Copy Markdown
Contributor

The README links the FAQ as a whole from two more sections, so the link stays when "What's new in PyBADS 1.5" is replaced by the next release's.

  • Documentation: a line under the documentation's address names what the FAQ covers (installing, the objective and the bounds, noisy objectives, the results, runs that go wrong) and links it.
  • Troubleshooting and contact: before the forum, an issue or an email, the README points to the FAQ and to its Troubleshooting section (checking a run, errors and warnings, results that differ from run to run, runs that stop too early or converge slowly). The sentence that introduces the list now begins "If the FAQ does not help".

The docs' index has neither section, and the docs list the FAQ in their sidebar, so index.rst is unchanged.

Docs only: no package files change, so merge-tests runs no tests, and there is no changelog entry. GitHub shows the change at the merge; PyPI shows it with the next release. pre-commit passes on README.md.

🤖 Generated with Claude Code

…ntact

The README's Documentation section says what the FAQ covers and links it; Troubleshooting and contact sends the reader to the FAQ, and its Troubleshooting section, before the forum, an issue or an email.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@lacerbi
lacerbi merged commit 76dd0d0 into main Oct 10, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant