docs: align docs with v1.1 and trim README#311
Merged
Conversation
Kendrick-Song
changed the title
Kendrick-Song
force-pushed
the
feat/docs-align-v1.1
branch
from
9db5e21 to
6e04862
Compare
cyfyifanchen
pushed a commit
that referenced
this pull request
Jun 25, 2026
* docs: re-link orphaned docs and slim engineering.md After #311 realigned the docs, index.md again omitted four files that exist under docs/: everos-demo, use-cases, migration-to-1.0.0, and release-notes-1.1.0. Restore them so every docs/*.md is reachable from the index, and rewrite engineering.md for an external audience. index.md: - Re-add a Tutorials section: everos-demo, use-cases - See also: + release-notes-1.1.0, + migration-to-1.0.0 - Reframe the Engineering section as contributor-facing (not "internal") engineering.md (575 -> 113 lines): - Drop internal-only material: the self-justifying scope rationale, the Claude Code loading internals, the infra failure-impact table, the roadmap, and the "investing in infrastructure" essay - Fix claims that were false for this GitHub repo: GitLab-primary CI, the dev/master branch model, and the Gitmoji commit convention - Keep what helps a contributor: toolchain, local make targets, the CI gates, and the main-branch + Conventional Commits workflow Conventions now match the repo's own .gitlint and GitHub Actions. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * docs: align engineering.md references with the slimmed doc Update the inbound descriptions of engineering.md now that it is a contributor reference rather than an "infrastructure overview", and repoint the one reference that named content the trim removed. - CLAUDE.md, README, README.zh-CN, architecture.md: reword the link text to "contributor engineering reference: build, test, CI, conventions" - CLAUDE.md: the GitFlow Lite rationale pointer now targets .claude/skills/new-branch/SKILL.md (engineering.md no longer carries it) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
2 participants
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
everos.toml+ome.tomlconfig (replacing.env)prompt_slots.mdto reflect shipped Layer 1 stategit cloneURL (was placeholder<repo>)engineering.md(privacy)Test plan
docs/index.md→ target files)make lintpasses (no source changes)🤖 Generated with Claude Code