Dockery/Trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-12-21 07:39:55 +01:00
Code Issues Packages Projects Releases Activity

docs(dev): reorganize and clean up technical documentation

Browse Source
This commit is contained in:
Elian Doran
2025-11-04 10:55:48 +02:00
parent db644f20ed
commit 0ae4defc6d
71 changed files with 1144 additions and 1757 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/Developer Guide/Developer Guide/Building/Documentation.md vendored
View File

@@ -1,24 +0,0 @@
# Documentation
## Editing the documentation
To edit the documentation run `pnpm edit-docs:edit-docs`. This will spin up a custom Trilium desktop instance which automatically imports the documentation into memory. Any changes will update in the background the files which can then be committed.
## Automation
The documentation is built via `apps/build-docs`:
1. The output directory is cleared.
2. The User Guide and the Developer Guide are built.
1. The documentation from the repo is archived and imported into an in-memory instance.
2. The documentation is exported using the shared theme.
3. The API docs (internal and ETAPI) are statically rendered via Redocly.
4. The script API is generated via `typedoc`
The `deploy-docs` workflow triggers the documentation build and uploads it to CloudFlare Pages.
## Building locally
In the Git root:
* Run `pnpm docs:build`. The built documentation will be available in `site` at Git root.
* To also run a webserver to test it, run `pnpm docs:preview` (this will not build the documentation) and navigate to `localhost:9000`.

2
docs/Developer Guide/Developer Guide/Building/Releasing a new version.md vendored
View File

@@ -8,7 +8,7 @@ Releases are usually made directly from the `main` branch.
The process is as follows:
1. Edit the <a class="reference-link" href="Documentation.md">Documentation</a> to add a corresponding entry in the _Release notes_ section.
1. Edit the <a class="reference-link" href="../Documentation.md">Documentation</a> to add a corresponding entry in the _Release notes_ section.
2. In the root `package.json`, set `version` to the new version to be released.
3. Run `chore:update-version` to automatically update the version of the rest of the `package.json` files.
4. Run `pnpm i` to update the package lock as well.