chore: Add Mise-en-place#2978
Open
squioc wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces mise-en-place to standardize and simplify local development setup for the documentation repository, and updates contributor instructions accordingly.
Changes:
- Add
mise.tomldefining tool versions (python,uv,node,yarn) and common tasks for docs and OpenAPI viewer workflows. - Update
README.mdto usemise run …commands for install and local serving (docs + OpenAPI viewer).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Updates local testing/setup instructions to use mise tasks instead of direct uv/yarn commands. |
| mise.toml | Adds mise toolchain pinning and task definitions for installing dependencies, serving/building docs, and running the OpenAPI viewer. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| The front end is placed in `./lib/openapi-viewer`. You need node and yarn installed. | ||
| To serve the doc locally, you need to load the back end service upper. | ||
| The front end is placed in `./lib/openapi-viewer`. To serve the doc locally, you need to load the back end service upper. |
| ``` | ||
|
|
||
| Launch the front | ||
| In another shell, Launch the front |
| run = "uv run mkdocs build -s" | ||
|
|
||
| [tasks."doc:dev"] | ||
| description = "Start the documentation server" |
|
Newest code from squioc has been published to preview environment 🚀 Latest deployment was built on 2026-05-07 14:07:18 (a442fbbc818614e183d0b5776f48acf90c4ee5f4). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hello,
I propose adding mise-en-place to ease the setup of the development environment for the documentation.
Mise will manage the installation of the tools (
uv,yarn) and will expose tasks to hide the complexity of some commands used for the changes in the documentation.