Skip to content

docs(ci): add documentation maintenance checklist and CONTRIBUTING.md#37

Draft
cursor[bot] wants to merge 2 commits into
mainfrom
greyzxc/issue-planning-and-setup-f971
Draft

docs(ci): add documentation maintenance checklist and CONTRIBUTING.md#37
cursor[bot] wants to merge 2 commits into
mainfrom
greyzxc/issue-planning-and-setup-f971

Conversation

@cursor

@cursor cursor Bot commented Jun 6, 2026

Copy link
Copy Markdown

Summary

/dinit session: picked #26 (bundled duplicate #20) from the documentation knowledge-management epic.

Changes

  1. CONTRIBUTING.md — Adds the tailored contributing workflow from docs/add-contributing-workflow (fork-and-PR, GlitchWorks agnostic architecture protocol, dev-master submodule boundary rules).
  2. .github/COMMIT_WORKFLOW_CHECKLIST.md — Adds a Documentation maintenance sub-checklist:
    • Update docs/ when features change
    • Record ADRs in DECISION_LOG.md
    • Archive conversations to docs/archive/
    • Update repos/registry.yaml when repo relationships change
  3. workspace/dinit-notes.md — Agent progress notes for this session.

Agnostic design

Related issues

Closes #26
Closes #20

Deferred (separate PRs): #21#25, #27 (README, AI_INSTRUCTIONS, DEV_ENVIRONMENT_SETUP, etc.)

Verification

  • Markdown-only change; no runtime impact
  • Checklist items match issue deliverable bullets
  • CONTRIBUTING.md cross-referenced from checklist

Labels

documentation

Open in Web View Automation 

cursoragent and others added 2 commits June 6, 2026 00:54
…buting-workflow

Co-authored-by: greyZ <k-dot-greyz@users.noreply.github.com>
Closes #26. Also closes duplicate #20.

Adds conditional documentation maintenance sub-checklist to
COMMIT_WORKFLOW_CHECKLIST.md covering feature docs, ADRs,
conversation archive, and repository switchboard updates.

Co-authored-by: greyZ <k-dot-greyz@users.noreply.github.com>
@k-dot-greyz k-dot-greyz added the documentation Improvements or additions to documentation label Jun 6, 2026 — with Cursor

@cursor cursor Bot left a comment

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Automation review — PR #37

Verdict: Looks good to merge (documentation-only, scoped correctly).

What this PR delivers

  • CONTRIBUTING.md — fork-and-PR workflow, GlitchWorks agnostic architecture protocol (§4), dev-master submodule boundary (§5)
  • .github/COMMIT_WORKFLOW_CHECKLIST.md — Documentation maintenance sub-checklist with conditional rollout note for paths introduced in #21#27
  • Bundles duplicate issues #26 / #20 cleanly

Cross-PR note

Follow-up PR #38 lands DOCUMENTATION_GUIDE.md, DECISION_LOG.md, docs/archive/, and repos/registry.yaml — the scaffold paths referenced in this checklist's rollout note. Merge order: either PR is fine; #38 does not conflict.

Deferred (intentional)

#22#25, #27 navigation/README updates remain separate to avoid PR spam — correct bundling strategy.

View PR

Open in Web View Automation 

Sent by Cursor Automation: hourly issue fixer

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

2 participants