Skip to content

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

Open
codeforester wants to merge 1 commit into
mainfrom
documentation/59-20261021-docs-add-curated-ai-context-and-maintenance-guidance
Open

codeforester wants to merge 1 commit into
mainfrom
documentation/59-20261021-docs-add-curated-ai-context-and-maintenance-guidance

Conversation

@codeforester

Copy link
Copy Markdown
Contributor

Summary

base-cli-demo is discovered as a Base-managed project but cannot be exported without .ai-context/. Add five curated Markdown pages covering the reference consumer, framework integration, reconciliation behavior, and validation workflow, with a deliberate INDEX order and links to canonical sources. Contribution guidance defines when the pack must be updated.

Issue

Fixes #59

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/validate.sh: 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.

Comment thread .ai-context/README.md
the exporter does not inline their targets. Keep core explanations self-contained.
Use real regular files, not symlinks. Store generated bundles outside the project
and keep generation timestamps out of source pages so unchanged exports remain
byte-identical. This pack is picked up automatically by workspace export jobs.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

correctness (docs accuracy): "This pack is picked up automatically by workspace export jobs" does not appear to be true — there is no automated job anywhere (checked base, base-cli-demo, base-workspace.yaml, and all .github/workflows in both repos) that invokes export-context. The only mechanism is the manual basectl export-context command (cli/bash/commands/basectl/subcommands/export_context.sh in base), which this same PR's own WORKFLOWS.md/CONTRIBUTING.md instruct readers to run by hand. A reader (human or agent) who trusts this line will assume the pack self-refreshes and skip the manual validation step the rest of the PR prescribes, letting the pack silently go stale.

Suggestion: drop the "picked up automatically" claim, or replace it with an accurate description of how the pack actually gets consumed/exported (manual basectl export-context).

Comment thread CONTRIBUTING.md
Maintain these curated summaries alongside meaningful changes to product scope,
architecture, commands, or contributor workflows. Canonical docs and code remain
the source of truth; update the pack when they disagree. State context impact in
the PR, including a reason when no update is needed. Typo-only and internal changes

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

altitude/process gap: this new rule ("State context impact in the PR, including a reason when no update is needed") has no enforcement path: .github/pull_request_template.md only has checklist items for "Documentation is updated..." and "CHANGELOG is updated..." — nothing for AI context impact. Contributors filling out the template have no prompt to state it, so the rule will likely be silently skipped in practice.

For comparison, basefoundry/base's own .github/pull_request_template.md has the equivalent teeth: "AI context is updated in .ai-context/, or the PR body explains why it is not applicable." Consider adding the same kind of checklist item here so the policy is actually operationalized rather than just asserted in prose.

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