Skip to content

[Docs] Clean-up the project documentation#268

Open
shorodilov wants to merge 18 commits intomainfrom
docs/clean-up
Open

[Docs] Clean-up the project documentation#268
shorodilov wants to merge 18 commits intomainfrom
docs/clean-up

Conversation

@shorodilov
Copy link
Collaborator

  • fix(docs): Revise ADR-004 decision to use separate repo
  • feat(docs): remove unused WP.md template and relocate mindmaps
  • fix(docs): update status badges order in multiple ADRs
  • feat(docs): add ADR-006 for presentation repo separation
  • feat(docs): finalize ADR-004 by removing impress.js submodule
  • fix(docs): make ADR-006 reference consistent with other ADRs
  • Update docs/ADR-004-presentation-framework.md
  • fix(docs): remove outdated implementation details in ADR-004
  • fix(docs): improve formatting for clarity in ADR-004
  • fix(docs): update ADR-006 status and improve formatting
  • fix(docs): standardize author formatting in tables
  • Fix ADR-004 description in ADR-002 intro note (Fix ADR-004 description in ADR-002 intro note #262)
  • docs: add file-location comment to ADR-006 for consistency (docs: add file-location comment to ADR-006 for consistency #264)
  • fix(docs): update link to work package template
  • feat(config): add category metadata to config.yaml
  • feat(ADR-001): move templates to top-level directory
  • feat(templates): add standard issue template for tasks

shorodilov and others added 17 commits January 31, 2026 00:59
Update ADR-004 to reflect a revised decision of extracting
presentations into a separate repository. This change improves
architectural clarity, simplifies the build process, and allows for
independent scaling and deployment of presentation tools.

Rationale for revision includes the need for standalone presentations,
independent build processes, and more flexible hosting options.
Details about implementation and consequences are also updated.

Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
Remove the unused `WP.md` template to clean up outdated or irrelevant
documentation. Additionally, relocate all `.mmd` mindmap files to the
`docs/mindmaps/` directory for better organization and consistency.

These changes aim to simplify the documentation structure and improve
repository maintainability.
Reorder the status badges in multiple ADR documents to maintain
consistency and proper formatting. Adjusting placement ensures cleaner
and more professional appearance across all relevant files.

Affected documents:
- ADR-001-ai-guidelines-structure.md
- ADR-002-ssg-replacement.md
- ADR-003-repo-file-structure.md
- ADR-004-presentation-framework.md
- templates/ADR.md
- templates/_changelog.md
Document architecture decision to extract presentation content into
a separate repository (`pymastery-presentations`). This ensures
clear separation of concerns, simplifies the build process, and
enables independent scaling and deployment of course content
and interactive visualization tools.

Rationale includes resolving mixed build system issues, improving
deployment independence, and future-proofing for multiple
presentations. This decision aligns with previously outlined efforts
in ADR-004.
Simplify the scope of ADR-004 by removing the impress.js git submodule
from the main repository. This finalizes the decision to deprecate the
use of impress.js in favor of handling all presentation frameworks and
content in a separate repository.

The removal reduces development friction, simplifies contributor
workflows, and focuses the main repo on course content delivery via
MkDocs. Presentation management will be addressed in ADR-006.

Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
Co-authored-by: shorodilov <22391544+shorodilov@users.noreply.github.com>
Co-authored-by: GitHub Copilot <noreply@github.com>

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Remove deprecated implementation instructions from ADR-004 to align
with the finalized decision of extracting presentation management to
a separate repository. Simplifies the document and improves clarity
by focusing on current dependencies and decisions.

Also updates ADR-003 for consistency, reflecting the accurate scope of
ADR-004 by revising its description.
Refactor text wrapping in ADR-004 to enhance readability and maintain
consistent formatting standards. Adjusts line breaks in bullet points
to prevent excessive line lengths in Markdown renderers.

No content or meaning changes made; purely for visual and structural
improvements.
Change the status of ADR-006 from "accepted" to "draft" to reflect its
current state. Improve document formatting by addressing wrapping
issues, fixing typos, and ensuring consistent terminology.

These changes enhance readability, maintain formatting standards, and
align the document content with overall repository conventions.
Update author column in documentation tables across multiple files to
ensure consistent formatting. Removed email addresses for a cleaner
presentation and improved readability.

Affected files:
- ROLES.md
- ADR-001-ai-guidelines-structure.md
- ADR-002-ssg-replacement.md
- ADR-003-repo-file-structure.md
- ADR-004-presentation-framework.md

This change aligns all documentation with repository standards and
enhances professionalism.
* Initial plan

* fix(docs): update ADR-002 to reflect revised ADR-004 scope

Co-authored-by: shorodilov <22391544+shorodilov@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: shorodilov <22391544+shorodilov@users.noreply.github.com>
* Initial plan

* docs: add file-location comment to ADR-006 for consistency

Co-authored-by: shorodilov <22391544+shorodilov@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: shorodilov <22391544+shorodilov@users.noreply.github.com>
Update broken link to the work package template in `ROLES.md`. The
new link points to the correct location in the GitHub issue templates
directory.

This change ensures accurate references and improves documentation
reliability.
Add `categories` metadata to `.ai/config.yaml` for better
classification of files. Categories such as "ai", "template",
"documentation", and "reporting" have been introduced to enhance
organization and enable easier file grouping.

This change simplifies future file management and supports improved
repository readability and maintainability.
Relocate `ADR.md` and `_changelog.md` from `docs/templates/` to a new
top-level `templates/` directory.

This change simplifies the repository structure and enhances the
discoverability of reusable templates for contributors.
Introduce a new `.github/ISSUE_TEMPLATE/task.md` file to standardize
task creation across the repository. The template provides structured
guidelines for defining tasks, including objectives, descriptions,
success criteria, and possible breaking changes.

This addition aims to improve task clarity, align contributions, and
enhance collaboration efficiency.
Copilot AI review requested due to automatic review settings March 6, 2026 00:36

This comment was marked as outdated.

@shorodilov shorodilov requested a review from Copilot March 6, 2026 00:43
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review any files in this pull request.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

4 participants