Skip to content

Update "Setup your docs environment" instructions to match current Hugo Modules layout#1965

Merged
Reshrahim merged 2 commits into
v0.59from
copilot/update-docs-environment-instructions
Jul 17, 2026
Merged

Update "Setup your docs environment" instructions to match current Hugo Modules layout#1965
Reshrahim merged 2 commits into
v0.59from
copilot/update-docs-environment-instructions

Conversation

Copilot AI commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Thank you for helping make the Radius documentation better!

Please follow this checklist before submitting:

  • Read the contribution guide
  • Commands include options for Linux, MacOS, and Windows within codetabs
  • New file and folder names are globally unique
  • Page references use shortcodes instead of markdown or URL links
  • Images use HTML style and have alternative text
  • Places where multiple code/command options are given have codetabs

In addition, please fill out the following to help reviewers understand this pull request:

Description

The contribution guide's setup steps pointed at a themes/docsy submodule that no longer exists and ran npm commands from the wrong directory, causing ENOENT/missing-directory errors for anyone following them from a fresh clone. The theme is now pulled in via Hugo Modules, and docs/package.json exposes npm start (not npm run dev).

  • docs/content/contributing/contributing-docs/index.md (Local machine setup):
    • Removed git submodule update --init --recursive and the cd themes/docsy && npm install step
    • Corrected working directory to docs/docs; use npm ci then npm start
    • Added note that Docsy is resolved automatically as a Hugo Module
    • Upmerge note now references the docsy Hugo Module version (docs/go.mod/docs/go.sum) instead of a submodule
  • docs/README.md: replaced both npm run dev references (no such script) with npm start

Setup now reads:

cd docs/docs
npm ci
npm start   # http://localhost:1313/

No remaining references to npm run dev, themes/docsy, or git submodule update across the docs.

Copilot AI changed the title [WIP] Update setup instructions for docs environment Update "Setup your docs environment" instructions to match current Hugo Modules layout Jul 17, 2026
Copilot AI requested a review from zachcasper July 17, 2026 15:07
@github-actions

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@github-actions

Copy link
Copy Markdown

Static Web App Preview

Environment Deployment
pr1965 View workflow run

Deployed from commit 745a2e44e875451515bf4f2e5f4a5a396d8e7164 via the publisher workflow.

@zachcasper
zachcasper marked this pull request as ready for review July 17, 2026 15:49
@zachcasper
zachcasper requested review from a team as code owners July 17, 2026 15:49
@Reshrahim
Reshrahim merged commit 23c8851 into v0.59 Jul 17, 2026
11 checks passed
@Reshrahim
Reshrahim deleted the copilot/update-docs-environment-instructions branch July 17, 2026 16:35
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.

Update "Setup your docs environment" instructions to match current repo layout

3 participants