docs: refresh the README after the repo import - #1
Merged
Merged
Conversation
- The local-preview snippet told you to cd into a "privacycommand website" folder. That nesting was flattened when the site was imported into git; the content is at the repository root. - Added the intended hostname and a pointer to the new docs site, so the boundary between marketing copy and product documentation is stated. - The go-live checklist asked you to confirm the docs/RELEASES.md link in legal.html "once the doc is in the repo". It never was — that path does not exist in privacycommand and never has. Points at the real release workflow instead.
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.
Three corrections now that the site is actually in git.
The local-preview command was wrong. It said
cd "privacycommand website"— that nesting existed on disk before the import and was flattened to the repository root, so thecdfails.Added the hostname and the docs-site boundary.
privacycommand.privacykey.org(DNS pending), and a pointer to docs-privacycommand, which didn't exist when this README was written. Worth stating so feature claims land in the right place.The go-live checklist had a task that can never complete. Item 6 asked you to confirm the
docs/RELEASES.mdlink inlegal.html"once the doc is in the repo". That file does not exist in privacycommand and never has — the same dead link appears in privacycommand's own README and ARCHITECTURE.md, fixed in privacykey/privacycommand#19.To be precise:
legal.htmldoes not actually contain that link — I checked. The checklist item was anticipating a link that was never added, so the item was stale in both directions. It now records that the path doesn't exist and points at the real release pipeline (.github/workflows/release.ymlcalling privacykey/gh-workflows).