@@ -4,11 +4,15 @@ This site is built with MkDocs and published to
44[ orenlab.github.io/codeclone] ( https://orenlab.github.io/codeclone/ ) .
55
66!!! note "Version Notice"
7- This site currently documents the in-development ` v2.0.x ` line from ` main ` .
8- For the latest stable CodeClone documentation (` v1.4.4 ` ), see the
9- [ ` v1.4.4 ` README] ( https://github.com/orenlab/codeclone/blob/v1.4.4/README.md )
10- and the
11- [ ` v1.4.4 ` docs tree] ( https://github.com/orenlab/codeclone/tree/v1.4.4/docs ) .
7+ This site currently documents the in-development ` v2.0.x ` line from ` main ` .
8+ For the latest stable CodeClone documentation (` v1.4.4 ` ), see the
9+ [ ` v1.4.4 ` README] ( https://github.com/orenlab/codeclone/blob/v1.4.4/README.md )
10+ and the
11+ [ ` v1.4.4 ` docs tree] ( https://github.com/orenlab/codeclone/tree/v1.4.4/docs ) .
12+
13+ !!! note "Repository licensing"
14+ CodeClone source code is licensed under MPL-2.0. Documentation content
15+ under ` docs/ ` and the published docs site is licensed under MIT.
1216
1317It has two documentation layers:
1418
@@ -91,13 +95,22 @@ help topics when the connected server exposes them.
9195
9296## Local Preview
9397
94- Build the docs site with MkDocs, then generate the sample report into the built
95- site:
98+ === "Build the site"
99+
100+ ```bash title="Validate the docs site"
101+ uv run --with mkdocs --with mkdocs-material mkdocs build --strict
102+ ```
103+
104+ === "Build the site and sample report"
105+
106+ ```bash title="Generate the live sample report into the built site"
107+ uv run --with mkdocs --with mkdocs-material mkdocs build --strict
108+ uv run python scripts/build_docs_example_report.py --output-dir site/examples/report/live
109+ ```
96110
97- ``` bash
98- uv run --with mkdocs --with mkdocs-material mkdocs build --strict
99- uv run python scripts/build_docs_example_report.py --output-dir site/examples/report/live
100- ```
111+ !!! note "Generated output"
112+ ` site/ ` is generated output. It is used for local preview and GitHub Pages
113+ publishing, but it is not committed to git.
101114
102115GitHub Pages publishing is handled by
103116[ ` docs.yml ` ] ( https://github.com/orenlab/codeclone/blob/main/.github/workflows/docs.yml )
0 commit comments