Skip to content

Commit

Permalink
Improve documentation for building slintdocs
Browse files Browse the repository at this point in the history
- Updated Quickstart and DSL docs in building.md to redirect to astro/README.md due to outdated information
- Fixed issues in astro/README.md that prevented it from working out of the box
  • Loading branch information
task-jp authored and tronical committed Dec 24, 2024
1 parent 3a10688 commit cc1a9be
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 14 deletions.
5 changes: 3 additions & 2 deletions docs/astro/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,14 @@ pnpm run build
This will build the site and place it in `dist/`.

## Live edit the docs
To run the live hot reloading dev server run:
To run the live hot reloading dev server run in the astro directory:

```bash
cd docs/astro/
pnpm start
```

This will start the dev server at [`localhost:4321/master/docs/slint`](http://localhost:4321/master/docs/slint).
This will start the dev server at [`localhost:4321/docs/`](http://localhost:4321/docs/).



Expand Down
13 changes: 1 addition & 12 deletions docs/building.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,18 +229,7 @@ The quickstart guide is part of the DSL documentation.

### Quickstart and DSL docs

The quickstart and DSL docs are written in markdown and built with Sphinx, using the myst parser extension.

**Prerequisites**:

- [pipenv](https://pipenv.pypa.io/en/latest/)
- [Python](https://www.python.org/downloads/)

Use the following command line to build the documentation using `rustdoc` to the `target/slintdocs/html` folder:

```shell
cargo xtask slintdocs --show-warnings
```
See [astro/README.md](astro/README.md)

### Rust API docs

Expand Down

0 comments on commit cc1a9be

Please sign in to comment.