Skip to content

docs: add curated AI context and maintenance guidance - #460

Merged
codeforester merged 3 commits into
mainfrom
documentation/459-20261021-docs-add-curated-ai-context-and-maintenance-guidance
Oct 27, 2026
Merged

codeforester merged 3 commits into
mainfrom
documentation/459-20261021-docs-add-curated-ai-context-and-maintenance-guidance

Conversation

@codeforester

@codeforester codeforester commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

Summary

base-cli is discovered as a Base-managed project but cannot be exported without .ai-context/. Add five curated Markdown pages covering Python CLI framework boundaries, public consumption patterns, runtime controls, and test strategy, with a deliberate INDEX order and links to canonical sources. Contribution guidance defines when the pack must be updated.

Issue

Fixes #459

Validation

  • Checked all relative source links in the five context files and reviewed the summaries against repository docs and implementation.
  • Real basectl export-context --list-files, Markdown, and Zip exports passed from this issue worktree.
  • Two consecutive Markdown exports are byte-identical; Zip entries match all five source files byte-for-byte.
  • git diff --cached --check before commit and git diff --check passed.
  • bash tests/full_validate.sh --gate baseline: passed.
  • bash tests/full_validate.sh --gate contracts: passed.

Docs Impact

Adds .ai-context/README.md, INDEX.md, PROJECT.md, ARCHITECTURE.md, and WORKFLOWS.md; adds maintenance guidance in CONTRIBUTING.md. The pack supplies offline orientation while canonical documentation/code remain authoritative. It does not claim that source links are inlined by the exporter.

Notes

No release version or CHANGELOG update: this is repository orientation, with no runtime behavior change. The optional Base scaffold enhancement is tracked separately in basefoundry/base#2627 and is not required to use this pack. After merge and checkout update, existing workspace export/sync jobs discover the directory automatically. This PR does not publish exports or change cloud synchronization.

Hosted validation status

The Windows benchmark passed on a targeted rerun of the unchanged PR commit: persistence_enabled_ms p95 57.66 ms, median 46.26 ms, below the unchanged 250 ms p95 limit (job).

The previous run measured 427.25 ms p95. Two runs of the unchanged base commit also measured 338.68 ms (failure) and 89.01 ms (success), confirming variable results independent of this documentation diff. No runtime, benchmark code, or threshold was changed. The still-queued workflow was canceled and its failed/unfinished jobs rerun; completed successful jobs were retained. All 104 hosted checks now completed successfully (or were intentionally skipped) on unchanged commit e1f9447; the macOS/Python 3.10 runtime job also passed.

Comment thread .ai-context/ARCHITECTURE.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread .ai-context/ARCHITECTURE.md Outdated
@codeforester

Copy link
Copy Markdown
Contributor Author

Addressed all three review findings in commit 634ab274 plus the main sync merge fc9fa669:

  • Corrected .ai-context/ARCHITECTURE.md: attachment.py/the attachment adapters and contracts are public; _attach.py is the private implementation module.
  • Clarified that only selected JSON-redaction helpers are part of the stable facade; the implementation-heavy redaction module is not itself a public facade module.
  • Added .ai-context/*.md to scripts/validate_docs.py so curated-pack links are checked by the normal documentation/contract gate. Updated CONTRIBUTING.md to require that validator when changing the pack.

Validation after syncing current main: full pytest passed (2 skipped), documentation/contract gate passed, Ruff and diff checks passed.

@codeforester
codeforester merged commit 66d871d into main Oct 27, 2026
110 checks passed
@codeforester
codeforester deleted the documentation/459-20261021-docs-add-curated-ai-context-and-maintenance-guidance branch October 27, 2026 18:28
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.

docs: add curated AI context and maintenance guidance

1 participant