docs: fix checklist rendering, merge dev pages#15
Merged
Conversation
- Add pymdownx.tasklist extension so [ ] checklists render as proper checkboxes instead of raw square brackets - Merge building.md + contributing.md into a single 'Development Guide' (they had ~80% duplicate content) - Update nav and cross-references Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the MkDocs documentation setup to correctly render Markdown task lists as checkboxes and consolidates duplicated developer documentation into a single “Development Guide” page.
Changes:
- Enabled
pymdownx.tasklistinmkdocs.ymlto render- [ ]/- [x]checklist syntax as checkboxes. - Merged “Building from Source” content into the (renamed) Development Guide and removed the redundant page.
- Updated MkDocs nav and “Next steps” cross-references to point to the consolidated guide.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
mkdocs.yml |
Adds task list rendering extension and updates Development nav to the consolidated guide. |
docs/development/contributing.md |
Renames/expands content into a unified Development Guide (setup, builds, debug, lint/test, workflow). |
docs/development/building.md |
Removes the duplicated “Building from Source” page after merging content. |
docs/development/architecture.md |
Updates “Next Steps” links to point at the consolidated Development Guide. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
Checklist Fix
Added
pymdownx.tasklistextension tomkdocs.ymlso- [ ]items render as proper checkboxes instead of showing raw square brackets.Merged Development Pages
Building from Source and Contributing had ~80% duplicate content (prerequisites, clone, tests, linting). Merged into a single Development Guide that covers everything:
Deleted
docs/development/building.md, updated nav and cross-references.