Repository navigation
docs: name the @flybot/project plugin in the READMEs and the indexes - #2844
Merged
Merged
Conversation
The Project plugin ships as @flybot/project but the root READMEs and the two index pages still describe only the other five peer plugins. - README.md and README.zh.md: one Project bullet in the feature list, between Workflows and Timeline. - docs/architecture.md: one plugins/project/ row in the layout table. - docs/subsystems/README.md: one project row in the subsystem index. Docs only; no code, tests or changelog fragment.
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.
Written-by: Dev
Fixes #2842
Owner: Dev
Reviewer: Reviewer
The Project plugin ships as
@flybot/project, but the pages that tell a reader what ships still list five plugins. This adds one bullet to each README, between Workflows and Timeline, and one row to each index page; the text claims only whatplugins/project/README.mdanddocs/subsystems/project.mddescribe.README.md/README.zh.md— the Project bullet in "Also in the app" / 「应用里还有」: Project State, the board, the Project's own Chief, the team dossier and metrics, the assistant; the core keeps the Project record and theproject-*endpoints; the domain is the plugin, switched in Settings like the others.docs/architecture.md— theplugins/project/row afterplugins/workflow/.docs/subsystems/README.md— theprojectrow between workflow and social.Actual: on today's main the architecture table row is at line 16 and the subsystem index row at line 14 (the issue's 12-15 had drifted). The browser half (board overlay, Projects nav) is still in core, so the text does not claim the UI is in the plugin.
Ran at this tip: 01aeab3
Not run:
npm run verifyand the core suite — docs only, no code or test file changed. This box has no git, socheck-arch-docsran with a read-only git shim that answers its three git reads from a byte diff of the pristine main tarball (40f59a12) against the working copy; the diff is exactly the four files below.Checkpoint
{ "pr": 2844, "claim": "Dev", "issue": 2842, "summary": "The root READMEs and the two index pages now name @flybot/project. Each README gains one Project bullet between Workflows and Timeline, describing Project State, the board, the Project's own Chief, the team dossier and metrics, and the assistant. docs/architecture.md gains a plugins/project/ row and docs/subsystems/README.md a project row between workflow and social. The text claims only what the plugin and subsystem pages describe, and says the core keeps the record and the project-* endpoints.", "files": ["README.md", "README.zh.md", "docs/architecture.md", "docs/subsystems/README.md"], "checks": { "ran": "grep -n plugins/project README.md README.zh.md docs/architecture.md docs/subsystems/README.md; node core/scripts/check-arch-docs.mjs; node scripts/lint-plugins.mjs", "result": "green", "at": "01aeab32ca626c52b6f0611ad1d147653d114652" }, "next": "none — ready for review" }