docs: update sync-content README with undocumented features#87
Open
sonupreetam wants to merge 1 commit into
Open
docs: update sync-content README with undocumented features#87sonupreetam wants to merge 1 commit into
sonupreetam wants to merge 1 commit into
Conversation
Add CLI Reference section with all 13 flags, Operational Details covering safety guards, HTTP client behaviour, and content processing edge cases. Fix inaccurate provenance comment claim, diagram language count, and Automation type keywords. Document always-on transforms for config sync, rewrite_diagrams config key, and all 6 GitHub Actions output variables. Update CONTRIBUTING.md test file description. Signed-off-by: sonupreetam <spreetam@redhat.com>
sonupreetam
force-pushed
the
docs/update-sync-content-readme
branch
from
d9ab5da to
02c7f40
Compare
trevor-vaughan
approved these changes
Jul 7, 2026
trevor-vaughan
left a comment
trevor-vaughan
left a comment
Member
There was a problem hiding this comment.
The update looks fine.
Filed #88 as a general follow up to address maintenance confusion.
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.
Summary
Audited
cmd/sync-content/README.mdagainst the actual source code and foundseveral gaps and inaccuracies. This PR brings the documentation up to date:
descriptions (
--token,--output,--include,--exclude,--timeoutwere previously undocumented)
protection, path traversal blocking, config source governance validation),
HTTP client behaviour (per-request timeout, response body limit, retry logic),
and content processing edge cases (
index.mdskipping, intermediate sectionpages, empty language fallback, max scan depth, manifest carry-forward)
config-declared files and auto-discovered doc pages; governance-generated
_index.md/overview.mduse frontmatter SHAs instead"automation"alongside"automat"stripLeadingH1,shiftHeadings,titleCaseHeadingsare unconditional)rewrite_diagramsto Configuration section and YAML exampleacknowledge
helpers_test.goNo code changes — documentation only.
Test plan
main.go,transform.go,sync.go,hugo.go,config.go,github.go)