docs: add self-contained reproduction & usage guideline page

Add docs/guideline.html, a single self-contained documentation guide
(left-nav + content + on-this-page TOC) covering installation, data
preparation, training/eval, full configuration reference, framework
internals, and an API reference. Link it from the README with local,
htmlpreview, and GitHub Pages access instructions.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
Cuzyoung
2026-05-31 09:01:25 +00:00
parent 00602df9e9
commit 8acc2dd03e
2 changed files with 934 additions and 0 deletions
+23
View File
@@ -14,6 +14,29 @@ https://github.com/user-attachments/assets/eb12d3bc-371c-467f-904d-91b61f339ed7
---
## Documentation
A complete, self-contained **Documentation & Reproduction Guide** lives at
[`docs/guideline.html`](docs/guideline.html). It covers installation, data
preparation, training/eval commands, the full configuration reference, the
framework internals (training loop, validation gate, slow update, meta skill),
and an API/function reference — all in a single page with a left navigation
sidebar.
Because GitHub shows raw source for `.html` files instead of rendering them,
open the guide one of these ways:
- **Locally** — clone the repo and open `docs/guideline.html` in any browser
(no build step required).
- **Rendered online (no setup)** — via the htmlpreview proxy:
[`htmlpreview.github.io/?…/docs/guideline.html`](https://htmlpreview.github.io/?https://github.com/microsoft/SkillOpt/blob/main/docs/guideline.html)
- **GitHub Pages** — the repository's GitHub Pages site already serves the
project homepage from the repo root, so the guide is reachable alongside it at
`https://microsoft.github.io/SkillOpt/docs/guideline.html` (the homepage at
`https://microsoft.github.io/SkillOpt/` is unaffected).
---
## Install
**Requirements:** Python 3.10+