Skip to content

docs: rewrite README as landing page, add 8 user-facing doc pages#62

Merged
digitarald merged 6 commits intomainfrom
docs/landing-page-rewrite
Mar 17, 2026
Merged

docs: rewrite README as landing page, add 8 user-facing doc pages#62
digitarald merged 6 commits intomainfrom
docs/landing-page-rewrite

Conversation

@digitarald
Copy link
Copy Markdown
Collaborator

Summary

Rewrites README from a detailed CLI reference into a concise landing page / pitch. Adds 8 new end-user documentation pages.

Changes

README.md — Landing page with:

  • "Context engineering for AI coding agents" tagline
  • Problem → solution intro (build/test/lint context, architecture, external services via MCP)
  • Measure / Generate / Maintain sections with one command each
  • "Works at every scale" table
  • "What gets generated" table
  • Compact docs table, troubleshooting section

New docs pages:

  • docs/getting-started.md — Prerequisites and first run
  • docs/concepts.md — Maturity model, readiness pillars, generation
  • docs/commands.md — Full CLI reference (every command, every flag)
  • docs/configuration.md — agentrc.config.json deep dive
  • docs/policies.md — Custom readiness scoring, extras
  • docs/at-scale.md — Batch processing, automated PRs, org-wide rollout
  • docs/ci-integration.md — GitHub Actions + Azure Pipelines examples
  • docs/extension.md — VS Code extension guide

Moved:

  • docs/plugins.mddocs/dev/plugins.md
  • docs/product.mddocs/dev/product.md

Updated: .github/workflows/daily-doc-updater.md paths

Review notes

  • All factual claims (9 pillars, 5 maturity levels, model defaults, generated files) verified against source code
  • Azure DevOps covered equally with GitHub across all pages
  • All cross-links verified intact

- README: concise pitch with Measure/Generate/Maintain sections
- New: getting-started, concepts, commands, configuration, policies,
  at-scale, ci-integration, extension
- Moved developer docs to docs/dev/
- Updated daily-doc-updater workflow paths
Copilot AI review requested due to automatic review settings March 16, 2026 02:33
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR restructures AgentRC’s documentation by turning the README into a concise landing page and moving the detailed end-user CLI reference and guides into dedicated docs/ pages.

Changes:

  • Rewrite README.md from a full CLI reference into a product-focused landing page with links to the new docs.
  • Add a set of end-user documentation pages covering concepts, commands, configuration, policies, CI integration, and scaling workflows.
  • Move developer-oriented docs under docs/dev/ and update the daily doc updater workflow references accordingly.

Reviewed changes

Copilot reviewed 10 out of 12 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
docs/policies.md New policy authoring guide and scoring/extras reference.
docs/getting-started.md New quickstart covering prerequisites, first run, and next steps.
docs/extension.md New VS Code extension usage/install/commands/settings guide.
docs/dev/product.md Product brief moved under developer docs.
docs/dev/plugins.md Plugin system architecture and API docs moved under developer docs.
docs/configuration.md New agentrc.config.json deep dive for areas/workspaces/policies.
docs/concepts.md New conceptual overview: maturity model, pillars, instructions, evals.
docs/commands.md New full CLI reference (commands + flags) replacing README’s prior role.
docs/ci-integration.md New CI guidance with GitHub Actions and Azure Pipelines examples.
docs/at-scale.md New guide for batch processing and automated PR workflows.
README.md Rewritten as landing page with docs navigation and troubleshooting.
.github/workflows/daily-doc-updater.md Update workflow’s documented doc-path mapping to include new/moved pages.
Comments suppressed due to low confidence (2)

docs/policies.md:163

  • This sentence says adding extras requires a TypeScript plugin because JSON can't express the detection function, but the current policy loader also rejects extras.add in JSON policies outright. Consider clarifying that adding extras is only supported via .ts/.js module policies (not JSON), and must be supplied via --policy (not via agentrc.config.json).
Adding new extras requires a TypeScript plugin — they need a detection function that JSON can’t express. See [Plugin System](dev/plugins.md).

docs/ci-integration.md:86

  • Same issue in the Azure Pipelines example: agentrc eval requires Copilot CLI availability and authentication, but the pipeline snippet doesn’t show how to provide that in CI. Please add a setup step or a note clarifying the requirement for runners.
  - script: npx github:microsoft/agentrc eval --fail-level 80 --json
    displayName: Run eval
    env:
      GITHUB_TOKEN: $(GITHUB_TOKEN)
      # AZURE_DEVOPS_PAT: $(AZURE_DEVOPS_PAT)
</details>

Comment thread docs/policies.md Outdated
Comment thread docs/configuration.md Outdated
Comment thread docs/concepts.md Outdated
Comment thread docs/ci-integration.md
Comment thread docs/getting-started.md Outdated
Comment thread .github/workflows/daily-doc-updater.md
Harald Kirschner added 2 commits March 15, 2026 20:55
- concepts.md: align pillar descriptions with actual checks
- configuration.md: fix policy path resolution (cwd, not config-relative)
- policies.md: clarify criteria.add requires TS/JS module policy
- ci-integration.md: add Copilot CLI note for eval in CI
- getting-started.md: add GH_TOKEN as auth alternative
- daily-doc-updater.md: CLI changes map to docs/commands.md
Copilot AI review requested due to automatic review settings March 17, 2026 02:15
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR restructures the repo’s documentation by converting README.md into a concise landing page and moving the detailed reference material into a set of dedicated end-user docs pages (plus relocating dev-oriented docs under docs/dev/).

Changes:

  • Rewrote README.md into a product landing page with a compact docs index and troubleshooting.
  • Added new end-user documentation pages covering getting started, concepts, commands, configuration, policies, CI integration, at-scale usage, and the VS Code extension.
  • Moved dev docs into docs/dev/ and updated the daily doc-updater guidance accordingly.

Reviewed changes

Copilot reviewed 10 out of 12 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
docs/policies.md New policies guide (usage, chaining, scoring, extras)
docs/getting-started.md New quickstart and first-run walkthrough
docs/extension.md New VS Code extension user guide
docs/dev/product.md Moved/updated product brief under dev docs
docs/dev/plugins.md Moved/updated plugin system architecture doc
docs/configuration.md New/rewritten configuration deep dive (agentrc.config.json)
docs/concepts.md New concepts overview (maturity model, pillars, instructions, eval)
docs/commands.md New full CLI reference (flags and commands)
docs/ci-integration.md New CI guidance with GitHub Actions + Azure Pipelines examples
docs/at-scale.md New batch/org-scale workflows guide
README.md Rewritten as landing page + doc index + troubleshooting
.github/workflows/daily-doc-updater.md Updated doc-location mapping to match new structure

Comment thread docs/ci-integration.md Outdated
Comment thread README.md Outdated
Comment thread docs/policies.md
Comment thread docs/policies.md Outdated
Copilot AI review requested due to automatic review settings March 17, 2026 03:21
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Reworks the repository documentation structure by turning the README into a concise landing page and moving detailed end-user guidance into a set of dedicated docs pages (including new “dev” docs for internal/plugin architecture).

Changes:

  • Rewrite README.md from a full CLI reference into a product/landing overview with links to deeper docs.
  • Add new end-user docs pages for getting started, concepts, commands, configuration, policies, CI integration, at-scale usage, and the VS Code extension.
  • Move plugin/product “developer” docs under docs/dev/ and update the daily doc updater guidance accordingly.

Reviewed changes

Copilot reviewed 10 out of 12 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
docs/policies.md New policy authoring/usage guide (JSON vs module policies, scoring, extras).
docs/getting-started.md New quickstart: prerequisites, first run, init/eval/readiness usage.
docs/extension.md New VS Code extension usage guide (commands, views, settings).
docs/dev/product.md New developer-facing product brief moved under docs/dev/.
docs/dev/plugins.md New developer-facing plugin system documentation moved under docs/dev/.
docs/configuration.md New agentrc.config.json deep dive (areas/workspaces/strategy/policies).
docs/concepts.md New conceptual overview (maturity model, pillars, instructions, eval).
docs/commands.md New full CLI reference (commands, flags, defaults).
docs/ci-integration.md New CI guidance with GitHub Actions + Azure Pipelines examples.
docs/at-scale.md New batch/org-scale workflows documentation.
README.md Landing page rewrite + docs index table + troubleshooting.
.github/workflows/daily-doc-updater.md Update doc-location guidance to point to the new docs layout.

Comment thread docs/commands.md Outdated
Comment thread docs/commands.md Outdated
Comment thread docs/at-scale.md Outdated
Comment thread docs/ci-integration.md Outdated
Comment thread docs/policies.md
@digitarald digitarald merged commit d0e78ac into main Mar 17, 2026
11 checks passed
@digitarald digitarald deleted the docs/landing-page-rewrite branch March 17, 2026 04:45
@github-actions github-actions Bot mentioned this pull request Mar 17, 2026
github-actions Bot pushed a commit that referenced this pull request Mar 18, 2026
Document the interactive keyboard shortcuts for `agentrc tui`, including
the main menu (G/R/E/B/M/J/Q), generate submenu (C/A/N), eval submenu
(R/I), batch submenu (G/A), and preview controls (S/D/Y/Q).

The R key for readiness and N key for nested area instructions were
updated in #55 but were not reflected in the docs rewrite (#62).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants