docs: reorganize implementation plan and expand contributing guidelines #409

Merged
freemo merged 17 commits from chore/removed-imp into master 2026-02-24 03:22:32 +00:00

17 Commits

Author SHA1 Message Date
freemo 417d17478f Docs: Explicitly indicated dependency direction for blocking characteristics in CONTRIBUTING.md
CI / benchmark-publish (pull_request) Has been skipped
CI / lint (pull_request) Successful in 15s
CI / quality (pull_request) Successful in 18s
CI / build (pull_request) Successful in 20s
CI / security (pull_request) Successful in 29s
CI / typecheck (pull_request) Successful in 32s
CI / integration_tests (pull_request) Successful in 3m12s
CI / unit_tests (pull_request) Successful in 6m51s
CI / docker (pull_request) Successful in 15s
CI / benchmark-regression (pull_request) Successful in 16m15s
CI / coverage (pull_request) Successful in 23m13s
CI / lint (push) Successful in 13s
CI / quality (push) Successful in 18s
CI / build (push) Successful in 21s
CI / typecheck (push) Successful in 33s
CI / benchmark-regression (push) Has been skipped
CI / security (push) Successful in 36s
CI / integration_tests (push) Successful in 2m33s
CI / unit_tests (push) Successful in 6m58s
CI / docker (push) Successful in 8s
CI / benchmark-publish (push) Successful in 10m17s
CI / coverage (push) Successful in 22m57s
2026-02-23 21:58:34 -05:00
freemo 67b4ddf5f8 Docs: Removed implementation-notes and migrated that information as comments on tickets
CI / benchmark-publish (pull_request) Has been skipped
CI / lint (pull_request) Successful in 13s
CI / build (pull_request) Successful in 15s
CI / quality (pull_request) Successful in 19s
CI / typecheck (pull_request) Successful in 32s
CI / security (pull_request) Successful in 53s
CI / integration_tests (pull_request) Successful in 3m29s
CI / unit_tests (pull_request) Successful in 6m46s
CI / docker (pull_request) Successful in 39s
CI / benchmark-regression (pull_request) Has been cancelled
CI / coverage (pull_request) Has been cancelled
2026-02-23 21:48:07 -05:00
freemo b1bf2250fb Docs: Switched back to using QOTO's kroki.
CI / benchmark-publish (pull_request) Has been skipped
CI / lint (pull_request) Successful in 14s
CI / build (pull_request) Successful in 18s
CI / quality (pull_request) Successful in 20s
CI / security (pull_request) Successful in 29s
CI / typecheck (pull_request) Successful in 34s
CI / integration_tests (pull_request) Successful in 3m44s
CI / unit_tests (pull_request) Successful in 7m9s
CI / docker (pull_request) Successful in 15s
CI / benchmark-regression (pull_request) Successful in 20m19s
CI / coverage (pull_request) Successful in 23m47s
2026-02-23 20:17:18 -05:00
freemo d9a492c3ff docs: add missing reference pages to mkdocs navigation
CI / benchmark-publish (pull_request) Has been skipped
CI / lint (pull_request) Successful in 14s
CI / build (pull_request) Successful in 16s
CI / quality (pull_request) Successful in 19s
CI / typecheck (pull_request) Successful in 31s
CI / security (pull_request) Successful in 32s
CI / unit_tests (pull_request) Has been cancelled
CI / coverage (pull_request) Has been cancelled
CI / benchmark-regression (pull_request) Has been cancelled
CI / integration_tests (pull_request) Has been cancelled
CI / docker (pull_request) Has been cancelled
Added decision_model, resource_handlers, and resources to the manually-authored
reference page nav entries in gen_ref_pages.py so mkdocs no longer warns about
pages existing in docs/reference/ but not included in the nav.

Refs: #408
2026-02-24 01:15:26 +00:00
freemo a7c51ed78c docs: clarify branch/tag ref rules for development vs non-development issues
CI / benchmark-publish (pull_request) Has been skipped
CI / lint (pull_request) Successful in 16s
CI / build (pull_request) Successful in 15s
CI / quality (pull_request) Successful in 19s
CI / security (pull_request) Successful in 30s
CI / typecheck (pull_request) Successful in 42s
CI / integration_tests (pull_request) Successful in 2m42s
CI / unit_tests (pull_request) Successful in 6m44s
CI / docker (pull_request) Successful in 21s
CI / coverage (pull_request) Has been cancelled
CI / benchmark-regression (pull_request) Has been cancelled
Refined the branch/tag (Ref) field requirement: development issues (features,
fixes, chores) must set it to the same branch as the one in the Metadata
section once the issue reaches State/In Progress, and must always reference a
branch not a tag. Non-development issues (bug reports, questions, support)
may leave it blank or optionally point to the branch or tag being referenced.

Refs: #408
2026-02-24 01:07:55 +00:00
freemo 0d5e97ff62 docs: require branch/tag ref field on all issues in contributing guidelines
CI / benchmark-publish (pull_request) Has been skipped
CI / lint (pull_request) Successful in 15s
CI / build (pull_request) Successful in 16s
CI / quality (pull_request) Successful in 19s
CI / typecheck (pull_request) Successful in 31s
CI / security (pull_request) Successful in 37s
CI / integration_tests (pull_request) Successful in 3m50s
CI / benchmark-regression (pull_request) Has been cancelled
CI / coverage (pull_request) Has been cancelled
CI / unit_tests (pull_request) Has been cancelled
CI / docker (pull_request) Has been cancelled
Added requirement that every issue must have its Forgejo branch/tag (Ref) field
set to the working branch once work begins. This field is separate from the
branch name in the issue body Metadata section but must match it. Setting the
field allows Forgejo to associate issues with branches in its UI.

Refs: #408
2026-02-24 01:03:49 +00:00
freemo bdda79f24b docs: add PR description and dependency link requirements to contributing guidelines
CI / benchmark-publish (pull_request) Has been skipped
CI / lint (pull_request) Successful in 15s
CI / quality (pull_request) Successful in 16s
CI / build (pull_request) Successful in 22s
CI / security (pull_request) Successful in 29s
CI / typecheck (pull_request) Successful in 30s
CI / integration_tests (pull_request) Successful in 4m3s
CI / coverage (pull_request) Has been cancelled
CI / benchmark-regression (pull_request) Has been cancelled
CI / unit_tests (pull_request) Has been cancelled
CI / docker (pull_request) Has been cancelled
Added explicit requirement that every PR must include a detailed description
with a summary, closing keywords for linked issues, and a Forgejo dependency
link. Updated the merge checklist with PR description and dependency link
verification items. Reworked PR Process item 1 to be comprehensive about
both the description body and the issue linkage.

Refs: #408
2026-02-24 00:59:09 +00:00
freemo 31094b20b9 docs: add milestone and PR label requirements to contributing guidelines
CI / benchmark-publish (pull_request) Has been skipped
CI / lint (pull_request) Successful in 14s
CI / build (pull_request) Successful in 14s
CI / quality (pull_request) Successful in 18s
CI / typecheck (pull_request) Successful in 31s
CI / security (pull_request) Successful in 35s
CI / integration_tests (pull_request) Successful in 2m45s
CI / unit_tests (pull_request) Successful in 6m53s
CI / docker (pull_request) Has been cancelled
CI / coverage (pull_request) Has been cancelled
CI / benchmark-regression (pull_request) Has been cancelled
Added milestone requirements: issues beyond State/Unverified must be assigned
to a milestone; PRs must be assigned to the same milestone as their linked
issues. Added PR label rules: every PR must carry exactly one Type/ label
matching the nature of the change. Updated the triaging checklist to include
milestone assignment and updated the merge checklist with milestone and label
verification items.

Refs: #408
2026-02-24 00:51:56 +00:00
freemo ccff33c7c7 docs: update changelog with documentation reorganization entries
CI / benchmark-publish (pull_request) Has been skipped
CI / lint (pull_request) Successful in 14s
CI / build (pull_request) Successful in 17s
CI / quality (pull_request) Successful in 20s
CI / security (pull_request) Successful in 29s
CI / typecheck (pull_request) Successful in 34s
CI / integration_tests (pull_request) Successful in 3m46s
CI / unit_tests (pull_request) Successful in 7m13s
CI / docker (pull_request) Successful in 39s
CI / benchmark-regression (pull_request) Successful in 20m19s
CI / coverage (pull_request) Has been cancelled
Added an Unreleased section to CHANGELOG.md describing all documentation
changes in this branch: CONTRIBUTING.md expansion, implementation plan
migration to docs/timeline.md and docs/implementation-notes.md, and
removal of the monolithic implementation_plan.md.

Refs: #408
2026-02-24 00:29:53 +00:00
freemo 87d842732b docs: Clarified metadata on CONTRIBUTING.md
Refs: #408
2026-02-23 19:25:12 -05:00
freemo 9563da6485 docs: Fixed broken image link in CONTRIBUTING.md
Refs: #408
2026-02-23 19:21:25 -05:00
freemo 96516f4944 docs: Expanded the CONTRIBUTING.md document to give more details to the process of contributing issues, and pull requests
Refs: #408
2026-02-23 19:16:17 -05:00
freemo 09c2567d60 docs: Moved the last elements from implementation plan to their respective locations and deleted the plan from the repo
Refs: #408
2026-02-23 17:53:26 -05:00
freemo fb7b20bd6b docs: Moved the notes taken during implementation to its own document
Refs: #408
2026-02-23 17:53:02 -05:00
freemo 69b99d49e6 docs: Moved the implementation timeline out to its own document
Refs: #408
2026-02-23 17:52:59 -05:00
freemo 9559414dc2 docs: Added commit guidlines to the contributing document
Refs: #408
2026-02-23 17:52:56 -05:00
freemo e53c301ab6 docs: Updated CONTRIBUTING.md to be inclusive of everything relevant from the implementation plan
Refs: #408
2026-02-23 17:52:50 -05:00