Skip to content

docs: fix inaccuracies and resolve CHANGELOG merge conflict #81

Description

@github-actions

Caution

Protected files were modified in this change.
This pull request is in request_review mode and requires explicit human scrutiny before merge.

Protected files: CHANGELOG.md, README.md

Summary

This PR fixes five documentation inaccuracies found during an audit of the codebase against its documentation.

Changes

CHANGELOG.md — Remove leftover git merge conflict marker

  • Line 42 contained a >>>>>>> 28aebca (feat(release): adopt attested delivery pipeline) conflict marker that was never cleaned up after a merge. Removed.

README.md — Remove non-existent --json flag from validate options

  • The validate command options listed --json Output as JSON, but ValidateArgs in src/cli/args.rs has no such flag. JSON output is a feature of stats --format json, not validate. Removed the incorrect option.

docs/user-guide.md — Fix wiki generated file names

  • The "Generated Pages" section listed Home.md, ADR-XXXX.md, Status-Index.md, Category-Index.md, Timeline.md. The actual WikiRenderer::render_all() in src/infrastructure/renderer/wiki.rs generates ADR-Index.md, ADR-By-Status.md, ADR-By-Category.md, ADR-Timeline.md, ADR-Statistics.md plus copies of the original ADR source files. Updated to match.

docs/user-guide.md — Fix validate exit code table

  • The table showed exit codes 0, 1, and 2 (warnings with --strict). The handler in src/cli/handlers.rs only ever returns Ok(0) (passed) or Ok(1) (failed). Warnings with --strict produce exit code 1, not 2. Table corrected.

docs/configuration.md — Fix wiki output structure diagram

  • Same file-name discrepancy as above (Home.md, Status-Index.md, Category-Index.md, Timeline.md) corrected to match actual renderer output.

Verification

Each fix was verified against the source code:

  • CHANGELOG.md conflict marker: plainly visible in file
  • --json absence: confirmed in src/cli/args.rs ValidateArgs struct
  • Wiki filenames: confirmed in src/infrastructure/renderer/wiki.rs render_all() return value
  • Exit codes: confirmed in src/cli/handlers.rs handle_validate() function

Generated by Update Docs · 639.8 AIC · ⌖ 14.6 AIC · ⊞ 37.2K · ◷

Add this agentic workflows to your repo

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/update-docs.md@adea00ee5830135f24022f1000d706c7f5fa24c4

Note

This was originally intended as a pull request, but the git push operation failed.

Workflow Run: View run details and download bundle artifact

The bundle file is available in the agent artifact in the workflow run linked above.

To create a pull request with the changes:

# Download the artifact from the workflow run
gh run download 27436430834 -n agent -D /tmp/agent-27436430834

# Fetch the bundle into a temporary ref, then update the local branch
git fetch /tmp/agent-27436430834/aw-docs-fix-inaccuracies-and-merge-conflict.bundle refs/heads/docs/fix-inaccuracies-and-merge-conflict:refs/bundles/create-pr-docs-fix-inaccuracies-and-merge-conflict-592bbe64d2f6420a-065179f7
git update-ref refs/heads/docs/fix-inaccuracies-and-merge-conflict-592bbe64d2f6420a refs/bundles/create-pr-docs-fix-inaccuracies-and-merge-conflict-592bbe64d2f6420a-065179f7
git checkout docs/fix-inaccuracies-and-merge-conflict-592bbe64d2f6420a
# Ensure the working tree matches the updated branch
git reset --hard
# Remove the temporary bundle ref
git update-ref -d refs/bundles/create-pr-docs-fix-inaccuracies-and-merge-conflict-592bbe64d2f6420a-065179f7

# Push the branch to origin
git push origin docs/fix-inaccuracies-and-merge-conflict-592bbe64d2f6420a

# Create the pull request
gh pr create --title 'docs: fix inaccuracies and resolve CHANGELOG merge conflict' --base main --head docs/fix-inaccuracies-and-merge-conflict-592bbe64d2f6420a --repo zircote/adrscope

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions