Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Deploy Docs to GitHub Pages

on:
push:
branches: [develop]
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4

- uses: actions/[email protected]
with:
python-version: "3.10"

- name: Install dependencies
run: pip install -r docs/sphinx/requirements.txt

- name: Build Sphinx docs
env:
DOCS_BASE_URL: https://amd-tme.github.io/instinct-docs/
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: sphinx-build -b html docs/ docs/_build/html

- name: Add .nojekyll
run: touch docs/_build/html/.nojekyll

- uses: actions/configure-pages@v5

- uses: actions/upload-pages-artifact@v4
with:
path: docs/_build/html

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-22.04
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
.venv
.vscode
build
.playwright-mcp/

# documentation artifacts
_build/
_images/
_static/
!docs/_static/
_templates/
_toc.yml
docBin/
Expand Down
1 change: 1 addition & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -73,5 +73,6 @@ DeepSeek
DriveNets
minimap
FFI
Slurm
Slurm's
WireGuard
40 changes: 40 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Contributing to AMD GPU Systems and Infrastructure documentation

Thanks for your interest in improving this site. This repository is a documentation-only project built with [Sphinx](https://www.sphinx-doc.org/) and [MyST](https://myst-parser.readthedocs.io/) via [rocm-docs-core](https://github.com/ROCm/rocm-docs-core), and published through Read the Docs.

## How to propose a change

1. Fork the repository and create a branch for your change.
2. Edit or add Markdown (MyST) content under `docs/`.
3. Build and review the site locally (see below) before opening a pull request.
4. Open a pull request against the `develop` branch, describing what changed and why.

Small fixes (typos, broken links, clarifications) are welcome without prior discussion. For larger structural changes (new sections, navigation changes), please open an issue first to discuss the approach.

## Building the documentation locally

See the [README](README.md#documentation-build-guide) for full setup instructions. In short:

```bash
python3 -m venv .venv/docs
source .venv/docs/bin/activate
pip install -r docs/sphinx/requirements.txt
python3 -m sphinx -b html -d _build/doctrees -D language=en ./docs/ docs/_build/html
```

Then serve `docs/_build/html/` locally to review your changes before submitting.

## Linting and spelling

Pull requests are checked by CI for:

- **Markdown linting** — standard Markdown formatting rules.
- **Spelling** — checked against a dictionary plus this repo's [`.wordlist.txt`](.wordlist.txt). If you introduce a legitimate technical term, product name, or acronym that isn't recognized, add it to `.wordlist.txt` in the same PR.

Both checks run automatically on every pull request; please fix any reported issues before requesting review.

## Reporting issues

If you find a problem with the documentation but aren't able to submit a fix yourself, please [open an issue](../../issues) describing the page, the problem, and (if applicable) the expected content.

For security-related concerns, see [SECURITY.md](SECURITY.md) instead of filing a public issue.
Loading
Loading