mirror of
https://github.com/zadam/trilium.git
synced 2025-12-31 04:30:01 +01:00
chore(docs): restructure developer guide for monorepo
This commit is contained in:
@@ -0,0 +1,23 @@
|
||||
# Documentation references in the application
|
||||
## Hard-coded links
|
||||
|
||||
Hard-coded links are present throughout the application, either in dialogs or in the source code as comments.
|
||||
|
||||
You can identify these links by searching for:
|
||||
|
||||
```
|
||||
https://triliumnext.github.io/Docs/Wiki/
|
||||
```
|
||||
|
||||
## Help buttons
|
||||
|
||||
There is a pattern of “?” buttons throughout the application which make use of the `data-help-page` attribute. Whenever these buttons are pressed, the user is redirected to the corresponding wiki page by prepending the wiki root URL to the `data-help-page` attribute.
|
||||
|
||||
Since the current wiki has a different structure than the original, for example to link to [https://github.com/TriliumNext/Docs/blob/main/Wiki/tree-concepts.md](https://github.com/TriliumNext/Docs/blob/main/Wiki/tree-concepts.md) the `data-help-page` attribute must be set to `tree-concepts.md`.
|
||||
|
||||
For links to headings, simply add the heading after the `.md`: `tree-concepts.md#prefix`
|
||||
|
||||
You can identify those by looking for:
|
||||
|
||||
* `.attr("data-help-page"`
|
||||
* `data-help-page="`
|
||||
Reference in New Issue
Block a user