Skip to content

docs: prepare Local Context Engine for the v1.0 release review - #20

Merged
styayur merged 2 commits into
mainfrom
docs/v1-release-readiness
Oct 16, 2026
Merged

styayur merged 2 commits into
mainfrom
docs/v1-release-readiness

Conversation

@styayur

@styayur styayur commented Oct 14, 2026 •

Copy link
Copy Markdown
Owner

What changes

Replace the development-log entry point with a Windows local-context discovery guide: installation, query examples, maturity boundaries, architecture and security. Consolidate canonical docs, publish the complete paired benchmark report with its limitations, and preserve previous narratives/raw captures in docs/archive.

Prepare an explicitly unreleased v1.0.0 changelog and user-facing release draft. Current published binaries remain v0.2.0. No Rust source, dependency, manifest, protocol, fixture, baseline, test or workflow change is included. .markdownlint.json only configures documentation lint.

Validation

  • Current Markdown lint and Git whitespace checks pass; historical archive formatting is preserved.
  • Local Markdown links/assets including archive paths and heading fragments checked; external endpoints returned successful responses (private-report availability still depends on GitHub settings).
  • English/Chinese README GFM rendered at 1280px and 390px; badges, tables and code blocks inspected.
  • Fresh-reader review addressed first-run scope and MCP privacy wording.
  • cargo test, cargo fmt --all -- --check, all-target/all-feature Clippy and CLI help smoke pass locally.
  • Frontend lint, typecheck and production build pass locally.
  • Six moved raw CSV/JSON/text captures retain identical content. Original PR CI and CodeForge Regression Gate both passed on ba25988.

Release boundary

Do not tag v1.0.0 from this PR alone. Versions are still 0.2.0; declared MSRV, desktop/service acceptance and complete benchmark environment provenance need validation. Desktop package/root-lock license metadata still says MIT while LICENSE/Cargo say MPL-2.0; the discrepancy is documented rather than silently relicensed.

See docs/DOCUMENTATION_MIGRATION.md for the added/moved/removed-content inventory and docs/RELEASE_PREPARATION.md for release gates. The v1.0.0 draft remains unpublished pending a separate release review.

@styayur
styayur merged commit 51fc5a2 into main Oct 16, 2026
3 checks passed
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.

1 participant