Repository navigation
📖 docs: plain-language default page — what Hive is, why it differs, hub vs spoke - #342
Merged
Merged
Conversation
…ub vs spoke Signed-off-by: Andrew Anderson <andy@clubanderson.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
✅ Deploy Preview for hivecommons-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
merged by Hive trusted-author auto-merge: author @clubanderson holds role owner and GitHub permission admin on repo; CI green at 31a36c9. |
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
1 participant
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.
Motivation
Smart readers in the CNCF TOC / BOINC / Discord review path could not quickly tell what Hive is, how it differs from running an agent in a terminal, how hub and spoke fit together, or where Hive ends and Hive Commons begins.
What changed
#does-hive-fit-my-projectwith links to the relevant Hive docs and source references.Anchor
FAQ: https://docs.hivecommons.dev/docs/community/what-is-hive-commons#does-hive-fit-my-project
Validation
npm test(fails locally on macOS case-insensitive filesystem inscripts/sync-hive-docs.main.test.ts; the test expectsreadme.mdto exist andREADME.mdnot to exist, which cannot be distinguished byfs.existsSyncon this filesystem)npm run lint:mdnpm run check-linksnpm run lintnpm run type-checknpm run format:checknpm run build