docs: slim README, split per-unit docs into docs/ - #38
Merged
Conversation
The README was a 396-line wall covering every action and workflow inline.
Replace it with a short overview plus two tables (composite actions,
reusable workflows) that link to a dedicated doc per unit under docs/.
- add docs/actions/{setup-node-npm,checkout,aws-credentials,setup-opentofu}.md
- add docs/workflows/{node-ci,security-scan,cloudflare-pages-deploy,notifications}.md
- notifications doc folds the router, formatter, and all pr-* handlers together
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.
What
The README was a 396-line wall documenting every action and workflow inline. This replaces it with a short overview and moves the detail into one doc per unit.
Changes
@mainreferencing / central-pinning model, a composite actions table, a reusable workflows table, and a single Telegram notifications quick start. Everything else links out.docs/actions/- one reference doc each forsetup-node-npm,checkout,aws-credentials,setup-opentofu(purpose, usage, inputs table, notes).docs/workflows/- one doc each fornode-ci,security-scan,cloudflare-pages-deploy, andnotifications(the notifications doc folds together the router, thetelegram-notifyformatter, and allpr-*/ci-statushandlers).Verification