Repository navigation
docs: add curated AI context and maintenance guidance - #460
Merged
codeforester merged 3 commits intoOct 27, 2026
Merged
codeforester merged 3 commits into
codeforester merged 3 commits into
Conversation
codeforester
commented
Oct 21, 2026
codeforester
commented
Oct 21, 2026
codeforester
commented
Oct 21, 2026
…61021-docs-add-curated-ai-context-and-maintenance-guidance
Contributor
Author
|
Addressed all three review findings in commit
Validation after syncing current |
codeforester
deleted the
documentation/459-20261021-docs-add-curated-ai-context-and-maintenance-guidance
branch
October 27, 2026 18:28
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.
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
basectl export-context --list-files, Markdown, and Zip exports passed from this issue worktree.git diff --cached --checkbefore commit andgit diff --checkpassed.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, andWORKFLOWS.md; adds maintenance guidance inCONTRIBUTING.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_msp95 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.