Vdoc

Changelog

🚀 Features
**ui**
- 83add4b Add settings sidebar and enable color theme toggle

🐛 Fixes
**tests**
- 971a25c Setup and tear down playwright mocks per spec file

🔄️ Changes
**tests**
- 468a224 Add static `testIDs` object for better test-id-referencing
- 34cf725 Move `page.goto('/')` from baseTest to each test
- ed6b0bd Add test setup method `prepareTestSuite` and fix imports
- aaedf71 Add and use `openProjectDocumentation` helper function

🧪 Tests
**ui**
- 26be9f7 Refactor test helper functions and add missing tests

**unscoped**
- ffb6475 Use `sphinxawesome-theme` as example docs theme and misc

🧰 Tasks

- 3824a27 Remove redundant comments and simplify code

🛠 Build
**deps**
- 317336e Bump tanstack/react-query from 5.62.2 to 5.66.0
- 20230a4 Bump tanstack/react-store from 0.6.1 to 0.7.0
- 037fe22 Bump the production-dependencies group with 4 updates
- f3f3eb2 Bump tanstack/react-router

**deps-dev**
- 6060ae5 Bump tanstack/eslint-plugin-query
- a3b4465 Bump eslint-plugin-react-refresh from 0.4.16 to 0.4.18
- 44e69e6 Bump eslint from 9.16.0 to 9.19.0
- 396ea72 Bump typescript from 5.6.3 to 5.7.3
- d9bb8d7 Bump eslint-plugin-react-hooks from 5.0.0 to 5.1.0
- 0a3a5ee Bump the development-dependencies group with 4 updates
- d44b945 Bump the development-dependencies group with 4 updates
- c417ab3 Bump vitest and vitest/coverage-v8

**ui**
- d8e0a13 Add `codecov/vite-plugin` as dev dependency

**unscoped**
- 2a83a93 Remove custom dependabot labels (27), closes 27
- 65a327d Group dependabot updates by dev/prod dependency
- 396ad6d Publish npm bundle analysis to codecov.io
- beb483f Upload code coverage to codecov.io

📝 Documentation

- 953a236 Add `codecov.io` coverage badge to `README`

---
- 70fdea4 Set playwright retries to 0 in order to detect flakyness earlier


Contributors
We'd like to thank the following people for their contributions:
- GitHub
- Jan-Frederik Schmidt
- dependabot[bot] ([dependabot[bot]](https://github.com/apps/dependabot))

Changelog

🚀 Features

- dc7e34f Correctly substitute documentation links for router-based navigation

🐛 Fixes
**ui**
- e8262da Fix router action from version overview to version

**unscoped**
- 7ed8e17 Fix status code (wrong name)

🧪 Tests
**e2e**
- 13d8f98 Add simple E2E tests for the start

**ui**
- 61c5294 Provide an actual index.html file for documentation mocks

**unscoped**
- ebda717 Add `vitest` config file

🛠 Build
**deps**
- 0641e11 Bump mui/icons-material from 6.1.10 to 6.4.2
- 4de28e3 Bump fontsource/roboto from 5.1.0 to 5.1.1
- 3bd89de Bump emotion/react from 11.13.5 to 11.14.0
- 7ae7b52 Bump emotion/styled from 11.13.5 to 11.14.0

**deps-dev**
- a278932 Bump vite
- af16e79 Bump tanstack/router-plugin from 1.85.9 to 1.98.6
- 01a9ef6 Bump eslint-config-prettier from 9.1.0 to 10.0.1
- de70d93 Bump typescript-eslint from 8.17.0 to 8.22.0
- 41cb5da Bump tanstack/router-devtools from 1.85.10 to 1.98.4
- 53a9d5e Bump globals from 15.13.0 to 15.14.0

**ui**
- bf49956 Add `playwright/test` as test dependency

**unscoped**
- d7ad93c Execute playwright tests in GitHub actions
- a579ec6 Bump `types/node` to 22.12.0
- 0900560 Add `dependabot.yml` file for automatic dependency updates

📝 Documentation

- afe8361 Add more config documentation to the README (11), closes 11


Contributors
We'd like to thank the following people for their contributions:
- GitHub
- Jan-Frederik Schmidt
- Michael Barulin ([MichaelBarulin](https://github.com/MichaelBarulin))
- dependabot[bot] ([dependabot[bot]](https://github.com/apps/dependabot))

Changelog

🐛 Fixes

- 78a71fa Add command to Dockerfile
- e2d4486 Remove Tanstack devtools from ui

🧰 Tasks

- e5c5551 Add pypi classifiers
- 9c31d88 Add `MichaelBarulin` to `CODEOWNERS`

📝 Documentation

- 701785f Use hosted docker image in the README


Contributors
We'd like to thank the following people for their contributions:
- Jan-Frederik Schmidt ([g3n35i5](https://github.com/g3n35i5))
- Michael Barulin

Changelog

🚀 Features
**api**
- 6d1d6f6 Add route for intersphinx object.inv fetching

**ui**
- 8efb73d Show message when no projects have been found
- 0809a1f Add empty state component
- 788e3b1 Set number of tanstack query retries to 1
- ab929ef Add dropdown to select project versions to app bar

**unscoped**
- 27145d9 Fist demo of frontend/backend interaction including dev scripts
- 8878a42 Add basic CLI using `typer`
- 37d847e Add basic REST API for projects
- cc82407 Add projects model and exceptions
- 9429ca3 Add settings model
- c7110f0 Simple UI layout for displaying documentation in an iframe
- 5339a13 🚨 Change UI docs url to `<PROJECT_NAME>/<VERSION>`
- 6d0e4d8 Merge router and `DocuCanvas` component.
- 61726cf Use tanstack router for documentation navigation (not fully working, yet)
- 6072685 Allow configuring bind address and bind port
- 3dfa521 Enable UI asset compression using `vite-plugin-compression2`
- c4feccc Add `latest` label to dropdown and change API
- c16193c Improve version index page for projects
- 11cd861 Show only 5 versions in the version dropdown and link to others
- 183f24c Add warning to CLI output when default credentials are used
- 337ccc4 Add authentication to upload route
- 8f9572d Add upload route to API
- 1ba7b64 Add app logo, favicon and docs

🐛 Fixes
**tests**
- 7dd39ef Wait for docs server to come online

**ui**
- 1ea0de9 Use correct selected version in dropdown
- f77beee Add keys to version selection dropdown
- 9a41c62 Fix pydantic error message location in FastAPI error

**unscoped**
- b5d5876 Fix routing for UI
- 9185af5 Return projects and project versions sorted
- ac56184 Change the HTTP response for uploading an existing version to 403

🔄️ Changes
**ui**
- 924ff48 Move REST API functions into separate helper module

**unscoped**
- dfaf6fb Improve MUI imports (use tree shaking)
- bcbe8b6 Move `QueryStateHandler` and `EmptyState` components
- 112f9aa Explicitely configure logger in main CLI
- 2758a96 Move constant variables to `constants.py` file
- 5930803 Add top margin to default loading component in `QueryStateHandler`
- 65591f3 Fix prettier issues
- 92310d1 Replace `voraus-logging-lib` with `RichHandler`
- ede58db Revert non-working integration test (3) (5), closes 3 5

🧪 Tests

- 2594c5c Fix intersphinx root labels
- 51aca8f Ensure that the sample docs are in sorted order and add more versions
- 6688b5f Add example documentations and stub for integration tests
- 2ba6e3e Add CLI tests
- 834ff9a Add UI unit tests
- c7cbd6b Add test that covers serving the static documentation files (3), closes 3

🧰 Tasks

- ad1836e Initial commit
- a76bd01 Add ui stub
- 7c4a462 Ignore cache directories from git (and linting tools)

🛠 Build
**ui**
- d93fc0b Add `tanstack/react-query`, `axios`, `prettier`, `types/node`
- 45711fd Add `eslint-config-prettier` as dev/lint dependency
- 1df9896 Add `tanstack/react-store` as dependency
- e861f8e Add `vitest` and `vitest/coverage-v8` as dev dependencies

**unscoped**
- a8e5109 Add `packaging` as runtime dependency
- c4560c3 Add `pydantic-settings`
- 11a4bde Add `voraus-logging-lib` as dependency
- 5fb3a62 Add `uvicorn` as dependency
- 0ff75e1 Add `typer` as dependency
- d822a2e Add `fastapi` as dependency
- 90dbc2a Add `tanstack/router` and dependencies
- 2ed3d50 Adding MUI and dependencies
- 299f200 Add basic dockerfile
- 7ce7499 Add build action and trigger pipeline also on tag builds
- 47ea52b Add tox env for building the web UI and add dependencies to build
- e9b3578 Add `python-multipart` as runtime dependency
- 6d4314a Run prettier and eslint in CI pipeline
- 00b6ceb Fix coverage aggregation
- 0034b7c Remove `voraus-logging-lib` as dependency
- 1a2987c Add `rich` as dependency
- b7db66f Split up GitHub actions into separate files
- c9ca8aa Publish vdoc docs to GitHub pages
- 57fed7c Upload python packages to pypi and create GitHub release
- 9e551ff Upload docker images to voraus JFrog Platform
- 0ca6384 Add docker build step on tag builds

📝 Documentation

- 38d9eb2 Add project readme for basic usage


Contributors
We'd like to thank the following people for their contributions:
- GitHub
- Jan-Frederik Schmidt
- Michael Barulin