diff --git a/README.md b/README.md index ae0419ed..cd5d37ed 100644 --- a/README.md +++ b/README.md @@ -220,6 +220,17 @@ jobs: Once the docs build is complete in your project, you can drop that change. +## Development docs + +To test `doc-builder` changes locally, use the `dummy/` folder. It contains a minimal setup for manual testing. Don't commit your changes in `dummy/` since it's only for local development. + +Run a preview with: +```bash +doc-builder preview dummy dummy --not_python_module +``` + +Documentation page should be available at `http://localhost:5173/index`. + ## Development Commands Since we've modernized the tooling to use `ruff` and `uv`, here are the commands for development: diff --git a/dummy/_toctree.yml b/dummy/_toctree.yml new file mode 100644 index 00000000..db985835 --- /dev/null +++ b/dummy/_toctree.yml @@ -0,0 +1,4 @@ +- title: 'Get started' + sections: + - local: index + title: Home \ No newline at end of file diff --git a/dummy/index.md b/dummy/index.md new file mode 100644 index 00000000..a13e39cb --- /dev/null +++ b/dummy/index.md @@ -0,0 +1,13 @@ +# Dummy docs + +This is a dummy doc page. You can add anything to it and then run + +```bash +doc-builder preview dummy dummy --not_python_module +``` + +Documentation page should be available at `http://localhost:5173/index`. + +Use this page as a playground to test new features developed in `doc-builder`. + +**Please do not commit changes on this file.**