docs: keep product documentation public, relocate engineering material - #1389
Open
Ndevu12 wants to merge 2 commits into
Open
docs: keep product documentation public, relocate engineering material#1389Ndevu12 wants to merge 2 commits into
Ndevu12 wants to merge 2 commits into
Conversation
The public repository now carries product and marketing documentation
only. Everything removed here is preserved in the private engineering
repository; nothing was discarded.
Removed (internal end to end):
docs/ARCHITECTURE.md, docs/SECURITY_ARCHITECTURE.md, docs/RELEASING.md,
CLAUDE.md, .claude/skills/ (8 skills), .claude/settings.json, and
public/stayawakebot_architecture.svg, whose embedded text rendered the
internal module layout.
Redacted in place, keeping the user-facing content:
README.md detection-technique enumeration, the Architecture
heading, the provenance rationale note, links to
relocated docs, and a real org name in an example
docs/CLI.md the design-rationale appendix
docs/USAGE.md the explanation of what a normal scan does not cover
CONTRIBUTING.md layering rule, module tree, principles, signature
and bot authoring steps
prevent/SECURITY_BASELINE.md
token hardening and recovery sections
.github/CODEOWNERS rationale comments; the ownership rules are unchanged
and still functional
Inbound links to relocated files were repaired in CONTRIBUTING.md,
docs/CONFIGURATION.md, docs/CREDENTIAL_HYGIENE.md, docs/USAGE.md and
.github/workflows/release.yml, so no dangling reference remains.
CHANGELOG.md and config/security.yml are deliberately untouched here.
The changelog needs a thin public replacement in the same change or the
release gate, the sdist allowlist and tests/test_changelog_release.py
break; the allowlist is consumed by CI and is being analysed separately.
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.
The public repository now carries product and marketing documentation only. Everything removed here
is preserved in the private engineering repository — nothing was discarded. Paired with
Ndevu12/saw#1.Removed (internal end to end)
docs/ARCHITECTURE.md,docs/SECURITY_ARCHITECTURE.md,docs/RELEASING.md,CLAUDE.md,.claude/skills/(8 skills),.claude/settings.json, andpublic/stayawakebot_architecture.svg,whose embedded text rendered the internal module layout.
Redacted in place, user-facing content kept
README.md## Architectureheading, the provenance rationale note, links to relocated docs, and a real org name in an exampledocs/CLI.mddocs/USAGE.mdCONTRIBUTING.mdprevent/SECURITY_BASELINE.md.github/CODEOWNERSInstall, usage, configuration, the CLI reference and licensing are unaffected.
docs/PREREQUISITES.mdis untouched and is now linked from the README's documentation list.
Inbound links to relocated files were repaired in
CONTRIBUTING.md,docs/CONFIGURATION.md,docs/CREDENTIAL_HYGIENE.md,docs/USAGE.mdand.github/workflows/release.yml, so no danglingreference remains.
Deliberately left for a follow-up
CHANGELOG.md— ~73% of its 172 entries carry internal detail and it belongs in the privaterepo, but removing it breaks
.github/scripts/check_changelog_release.py, thepyproject.tomlsdist allowlist and
tests/test_changelog_release.py. It needs a thin public replacement in thesame change.
config/security.yml— its allowlist is a published index of signature IDs and theirsuppression paths, but CI consumes the file, so it is being analysed separately.
pyproject.tomlsetsreadme = "README.md", so this trim does not reach PyPI until the nextrelease republishes the long description.