mcpField
D
docs-platform-rollout

docs-platform-rollout

github.com/dhananjaypawar26Development038 installsUpdated 33w ago
Repository

About docs-platform-rollout

docs-platform-rollout is a self-contained skill for setting up project documentation and publishing it with Docusaurus and Vercel. It guides documentation structure, site configuration, and local build validation in one workflow.

Key features

  1. 01Bootstraps a governed docs structure
  2. 02Sets up a Docusaurus site in website/
  3. 03Configures Vercel deployment
  4. 04Adds root npm scripts for docs
  5. 05Validates the local site build

Use cases

  1. 01Creating documentation for a new project
  2. 02Standardizing an existing docs/ directory
  3. 03Publishing root docs through Vercel

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/dhananjaypawar26/docs-platform-rollout --skill docs-platform-rollout

After installing, type/docs-platform-rolloutin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

README.md
references/
docs-docusaurus-vercel.SKILL.md
project-docs-bootstrap.SKILL.md
skills-usage-and-vercel-deployment.md

Details

From the project README

Docs Platform Rollout

Use this skill when the user wants complete documentation setup in one run.

Scope

This skill is self-contained and ships the implementation details it needs in references/.

Bundled references:

  1. references/project-docs-bootstrap.SKILL.md
  2. references/docs-docusaurus-vercel.SKILL.md
  3. references/skills-usage-and-vercel-deployment.md

How to load references

Read the references in this order before making changes:

  1. references/project-docs-bootstrap.SKILL.md
  2. references/docs-docusaurus-vercel.SKILL.md
  3. references/skills-usage-and-vercel-deployment.md only when deployment or reuse guidance is needed

Workflow order

  1. Use references/project-docs-bootstrap.SKILL.md to create or standardize the docs/ structure and baseline content.
  2. Use references/docs-docusaurus-vercel.SKILL.md to publish docs with Docusaurus and configure Vercel deployment.
  3. Validate local docs build and list deployment steps.

Inputs to confirm

  • Project/repo name
  • Branch strategy (auto deploy or manual production promotion)
  • Desired docs route (/docs or /)
  • Vercel root strategy (repo root or website)

Required outputs

  • Production-ready docs/ structure with governance metadata.
  • website/ Docusaurus site consuming root docs.
  • vercel.json aligned to root-directory strategy.
  • Root npm scripts for docs dev/build/serve.
  • Validation result from local docs build.

Acceptance criteria

  • Docs structure exists and is internally consistent.
  • npm --prefix website run build succeeds.
  • Sidebar renders all configured sections.
  • Vercel deployment config is explicit and reproducible.
  • The skill can be copied alone into another repo under .agents/skills/docs-platform-rollout/ and still be usable.

Failure handling

  • If docs build fails, fix MDX/sidebar/routes before finishing.
  • If Vercel setup fails, provide exact fallback mode (Mode A or Mode B) and branch/deploy instructions.

Comments

Markdown supported