-
Notifications
You must be signed in to change notification settings - Fork 206
docs: improve operator onboarding runbooks #16008
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
+71
−40
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,48 @@ | ||
| # Startlight Docs | ||
|
|
||
| ## Project Structure | ||
|
|
||
| Inside of your Astro + Starlight project, you'll see the following folders and files: | ||
|
|
||
| ```text | ||
| . | ||
| ├── public/ | ||
| ├── src/ | ||
| │ ├── assets/ | ||
| │ ├── content/ | ||
| │ │ └── docs/ | ||
| │ └── content.config.ts | ||
| ├── astro.config.mjs | ||
| ├── package.json | ||
| └── tsconfig.json | ||
| # gh-aw Documentation Workspace | ||
|
|
||
| This directory contains the Astro/Starlight site for GitHub Agentic Workflows docs. | ||
|
|
||
| ## Operator Quick Start | ||
|
|
||
| Run all commands from the repository root: | ||
|
|
||
| ```bash | ||
| make deps-docs | ||
| make dev-docs | ||
| ``` | ||
|
|
||
| Then open `http://localhost:4321`. | ||
|
|
||
| ## Build and Preview | ||
|
|
||
| ```bash | ||
| make build-docs | ||
| make preview-docs | ||
| ``` | ||
|
|
||
| Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name. | ||
| `build-docs` writes the static site to `docs/dist`. | ||
|
|
||
| Images can be added to `src/assets/` and embedded in Markdown with a relative link. | ||
| ## Where To Edit Content | ||
|
|
||
| Static assets, like favicons, can be placed in the `public/` directory. | ||
| - Main docs pages: `docs/src/content/docs/` | ||
| - Blog pages: `docs/src/content/docs/blog/` | ||
| - Public static assets: `docs/public/` | ||
| - Starlight config: `docs/astro.config.mjs` | ||
|
|
||
| ## 🧞 Commands | ||
| ## Suggested Validation Before PR | ||
|
|
||
| All commands are run from the root of the project, from a terminal: | ||
| From repository root: | ||
|
|
||
| ```bash | ||
| make lint | ||
| make test | ||
| make build-docs | ||
| ``` | ||
|
|
||
| | Command | Action | | ||
| | :------------------------ | :----------------------------------------------- | | ||
| | `npm install` | Installs dependencies | | ||
| | `npm run dev` | Starts local dev server at `localhost:4321` | | ||
| | `npm run build` | Build your production site to `./dist/` | | ||
| | `npm run preview` | Preview your build locally, before deploying | | ||
| | `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | | ||
| | `npm run astro -- --help` | Get help using the Astro CLI | | ||
| For a docs-only change, this keeps checks aligned with repo standards while confirming docs compile. | ||
|
|
||
| ## Want to learn more? | ||
| ## Troubleshooting | ||
|
|
||
| Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat). | ||
| - Reinstall docs dependencies: `make deps-docs` | ||
| - Remove docs build artifacts: `make clean-docs` | ||
| - If Astro dev fails after dependency updates, rerun `make deps-docs` and then `make dev-docs` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot move to contributor.md