Skip to content

docs(rails): add rail installation guidance - #2196

Draft
Pouyanpi wants to merge 6 commits into
pouyanpi/rail-library-requirementsfrom
pouyanpi/rail-library-installation-plans
Draft

docs(rails): add rail installation guidance#2196
Pouyanpi wants to merge 6 commits into
pouyanpi/rail-library-requirementsfrom
pouyanpi/rail-library-installation-plans

Conversation

@Pouyanpi

Copy link
Copy Markdown
Collaborator

Description

Build installation plans from rail manifests and expose them through
nemoguardrails rails requirements for selected rails or a configuration. The
command supports human-readable, requirements-file, and JSON output and never
installs packages or reads environment-variable values.

Generate a central requirements reference and an installation block on every
built-in rail catalog page. Pre-commit and tests reject stale generated content.

Generated documentation:

  • docs/configure-rails/guardrail-catalog/rail-installation-requirements.mdx
    is fully auto-generated.
  • Blocks between {/* BEGIN GENERATED RAIL REQUIREMENTS */} and
    {/* END GENERATED RAIL REQUIREMENTS */} in
    docs/configure-rails/guardrail-catalog/**/*.mdx are auto-generated. The rest of
    each catalog page remains hand-authored.

For future manifest changes, run make generate-rail-requirements and commit the
result. Documentation preview and publication workflows should run
make check-rail-requirements before the Fern build so stale pages cannot be
published. The published site should consume committed MDX rather than generate
requirements at runtime.

Related Issue(s)

  • Fixes #
  • Issue assignee: @

Verification

  • Full make test: 5,951 passed, 178 skipped.
  • Pre-commit and uv lock --check passed.
  • Local Fern preview rendered the generated catalog pages.

AI Assistance

  • No AI tools were used.
  • AI tools were used; a human reviewed and can explain every change (tool: Codex).

Checklist

  • I've read the CONTRIBUTING guidelines.
  • This PR links to a triaged issue assigned to me.
  • My PR title follows the project commit convention.
  • I've updated the documentation and tests.
  • I've noted checks that require credentials.
  • I did not update generated changelog files manually.
  • @mentions of the person or team responsible for reviewing proposed changes.

@github-actions github-actions Bot added status: needs triage New issues that have not yet been reviewed or categorized. size: XL labels Jul 21, 2026
@Pouyanpi
Pouyanpi force-pushed the pouyanpi/rail-library-requirements branch from 61d4637 to b233b7d Compare July 22, 2026 07:13
@Pouyanpi
Pouyanpi force-pushed the pouyanpi/rail-library-installation-plans branch 2 times, most recently from 537d74d to 4430664 Compare July 22, 2026 08:16
@Pouyanpi
Pouyanpi force-pushed the pouyanpi/rail-library-requirements branch from b233b7d to 7eed276 Compare July 22, 2026 08:16
@Pouyanpi
Pouyanpi force-pushed the pouyanpi/rail-library-installation-plans branch from 4430664 to 2def72d Compare July 22, 2026 13:39
@Pouyanpi
Pouyanpi force-pushed the pouyanpi/rail-library-requirements branch from 7eed276 to 02e7a2a Compare July 22, 2026 13:39
Pouyanpi added 5 commits July 23, 2026 12:13
Signed-off-by: Pouyanpi <13303554+Pouyanpi@users.noreply.github.com>
Signed-off-by: Pouyanpi <13303554+Pouyanpi@users.noreply.github.com>
Signed-off-by: Pouyanpi <13303554+Pouyanpi@users.noreply.github.com>
Signed-off-by: Pouyanpi <13303554+Pouyanpi@users.noreply.github.com>
Signed-off-by: Pouyanpi <13303554+Pouyanpi@users.noreply.github.com>
@Pouyanpi
Pouyanpi force-pushed the pouyanpi/rail-library-requirements branch from 02e7a2a to f545de8 Compare July 23, 2026 10:18
@Pouyanpi
Pouyanpi force-pushed the pouyanpi/rail-library-installation-plans branch from 2def72d to 0c73c58 Compare July 23, 2026 10:18
Signed-off-by: Pouyanpi <13303554+Pouyanpi@users.noreply.github.com>
@Pouyanpi
Pouyanpi marked this pull request as draft July 24, 2026 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size: XL status: needs triage New issues that have not yet been reviewed or categorized.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant