Skip to content

polish docs references and troubleshooting#28

Open
AllanChain wants to merge 13 commits into
mainfrom
fix/docs-minor
Open

polish docs references and troubleshooting#28
AllanChain wants to merge 13 commits into
mainfrom
fix/docs-minor

Conversation

@AllanChain
Copy link
Copy Markdown
Member

@AllanChain AllanChain commented Apr 28, 2026

  • Fixes docs source links by setting the docs path for the theme.
  • Adds the Read the Docs 404 page extension.
  • Redirect to https://jaqmc.readthedocs.io/ for users still using the GitHub Pages site.
  • Preserves full field descriptions in generated config references instead of truncating them to the first sentence.
  • Replace graphviz workflow illustration with SVG.
  • Clarify density defaults and dimensionality.
  • Update the troubleshooting page to make it more useful.

@AllanChain AllanChain changed the title Fix/docs minor fix source buttons and config references in docs Apr 28, 2026
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Apr 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.38%. Comparing base (786f080) to head (0281c7c).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #28   +/-   ##
=======================================
  Coverage   86.38%   86.38%           
=======================================
  Files         125      125           
  Lines        5650     5650           
  Branches      522      522           
=======================================
  Hits         4881     4881           
  Misses        560      560           
  Partials      209      209           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@AllanChain AllanChain changed the title fix source buttons and config references in docs polish docs references and setup guidance Apr 29, 2026
@AllanChain AllanChain changed the title polish docs references and setup guidance polish docs references and troubleshooting Apr 29, 2026
@AllanChain AllanChain marked this pull request as draft April 29, 2026 06:56
@AllanChain AllanChain force-pushed the fix/docs-minor branch 2 times, most recently from e306aa4 to 9459c2d Compare May 4, 2026 00:37
@AllanChain AllanChain marked this pull request as ready for review May 4, 2026 00:37
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.

2 participants