Skip to content

docs: improve module index descriptions and update architecture overview#12

Merged
HectorMozo3110 merged 14 commits intoNeureonmindflux-Research-Lab:mainfrom
HectorMozo3110:main
Nov 14, 2025
Merged

docs: improve module index descriptions and update architecture overview#12
HectorMozo3110 merged 14 commits intoNeureonmindflux-Research-Lab:mainfrom
HectorMozo3110:main

Conversation

@HectorMozo3110
Copy link
Copy Markdown
Member

@HectorMozo3110 HectorMozo3110 commented Nov 13, 2025

This update improves the overall documentation structure by refining the description and context of each module, enhancing navigation, and updating the architecture overview to better reflect the current design of QML-HCS.

Documentation Update Checklist

  • Updated the index.rst of each module with clearer descriptions and context
  • Improved internal navigation and added consistent cross-links between modules
  • Standardized the introduction sections across all module index pages
  • Updated architecture.rst with corrected diagrams and contextual explanations
  • Fixed outdated paths and ensured all Sphinx references resolve correctly
  • Added bold + link style for module reference sections
  • Validated that Sphinx builds without documentation reference warnings

@HectorMozo3110 HectorMozo3110 added the documentation Improvements or additions to documentation label Nov 13, 2025
@HectorMozo3110 HectorMozo3110 self-assigned this Nov 13, 2025
@codecov
Copy link
Copy Markdown

codecov Bot commented Nov 13, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@HectorMozo3110 HectorMozo3110 merged commit f9f6b54 into Neureonmindflux-Research-Lab:main Nov 14, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant