Skip to content

Doc: Standardize, codify how-to prerequisites#931

Open
akcano wants to merge 2 commits into
mainfrom
docs/prerequisites
Open

Doc: Standardize, codify how-to prerequisites#931
akcano wants to merge 2 commits into
mainfrom
docs/prerequisites

Conversation

@akcano

@akcano akcano commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

No description provided.

@akcano akcano requested review from Copilot and dmitry-lyfar July 9, 2026 17:38
@akcano akcano self-assigned this Jul 9, 2026
@akcano akcano marked this pull request as draft July 9, 2026 17:39

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 standardizes how documentation pages present prerequisites by codifying a consistent “Prerequisites” section pattern in the doc style guide and applying that pattern across several how-to pages.

Changes:

  • Standardizes prerequisite section opening wording to “Before starting, ensure you have these requirements satisfied:” and formats prerequisites as bullet lists.
  • Refactors multiple existing prerequisite sections to match the new standard.
  • Adds an explicit prerequisites section to the “use host devices” how-to and documents the convention in the style guide.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs/how-to/develop-with-workshops/use-workshops-with-ai-agents.rst Rewrites prerequisites into a standardized bullet list format.
docs/how-to/develop-with-workshops/run-workshops-in-github-actions.rst Standardizes prerequisite section intro wording.
docs/how-to/develop-with-workshops/run-jetbrains-gateway.rst Standardizes prerequisite section intro wording and list indentation.
docs/how-to/develop-sdks/write-runtime-hooks.rst Converts prerequisites to the new standardized bullet list format.
docs/how-to/develop-sdks/declare-plugs-slots.rst Converts prerequisites to the new standardized bullet list format.
docs/how-to/develop-sdks/configure-mount.rst Converts prerequisites to the new standardized bullet list format.
docs/how-to/customize-workshops/use-host-devices.rst Adds a new prerequisites section aligned with the new convention.
docs/doc-style-guide.md Codifies the prerequisites-section convention with guidance and an example.

Comment thread docs/how-to/develop-with-workshops/use-workshops-with-ai-agents.rst
Comment thread docs/doc-style-guide.md Outdated
@akcano akcano marked this pull request as ready for review July 9, 2026 18:44
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