diff --git a/docs/ADRs/adr001.md b/docs/ADRs/adr001.md new file mode 100644 index 0000000..4acadbe --- /dev/null +++ b/docs/ADRs/adr001.md @@ -0,0 +1,20 @@ +--- +status: draft +date: 2025-12-05 +author: max +--- + +# ADR 001 Test + +## Context and Problem Statement + +TODO + +## Considered Options + +TODO + +## Decision + + +### Consequences diff --git a/docs/ADRs/index.md b/docs/ADRs/index.md new file mode 100644 index 0000000..986cb6e --- /dev/null +++ b/docs/ADRs/index.md @@ -0,0 +1,7 @@ +# Servala ADRs + +Servala uses ADRs (Architecture Decision Records) to document all the technical details and decision. + +## Inspiration + +- [MADR Template](https://www.ozimmer.ch/practices/2022/11/22/MADRTemplatePrimer.html) diff --git a/docs/index.md b/docs/index.md index 3b76a8a..c824c1b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,166 +1,3 @@ ---- -icon: lucide/rocket ---- +# Welcome to Servala -# Get started - -For full documentation visit [zensical.org](https://zensical.org/docs/). - -## Commands - -* [`zensical new`][new] - Create a new project -* [`zensical serve`][serve] - Start local web server -* [`zensical build`][build] - Build your site - - [new]: https://zensical.org/docs/usage/new/ - [serve]: https://zensical.org/docs/usage/preview/ - [build]: https://zensical.org/docs/usage/build/ - -## Examples - -### Admonitions - -> Go to [documentation](https://zensical.org/docs/authoring/admonitions/) - -!!! note - - This is a **note** admonition. Use it to provide helpful information. - -!!! warning - - This is a **warning** admonition. Be careful! - -### Details - -> Go to [documentation](https://zensical.org/docs/authoring/admonitions/#collapsible-blocks) - -??? info "Click to expand for more info" - - This content is hidden until you click to expand it. - Great for FAQs or long explanations. - -## Code Blocks - -> Go to [documentation](https://zensical.org/docs/authoring/code-blocks/) - -``` python hl_lines="2" title="Code blocks" -def greet(name): - print(f"Hello, {name}!") # (1)! - -greet("Python") -``` - -1. > Go to [documentation](https://zensical.org/docs/authoring/code-blocks/#code-annotations) - - Code annotations allow to attach notes to lines of code. - -Code can also be highlighted inline: `#!python print("Hello, Python!")`. - -## Content tabs - -> Go to [documentation](https://zensical.org/docs/authoring/content-tabs/) - -=== "Python" - - ``` python - print("Hello from Python!") - ``` - -=== "Rust" - - ``` rs - println!("Hello from Rust!"); - ``` - -## Diagrams - -> Go to [documentation](https://zensical.org/docs/authoring/diagrams/) - -``` mermaid -graph LR - A[Start] --> B{Error?}; - B -->|Yes| C[Hmm...]; - C --> D[Debug]; - D --> B; - B ---->|No| E[Yay!]; -``` - -## Footnotes - -> Go to [documentation](https://zensical.org/docs/authoring/footnotes/) - -Here's a sentence with a footnote.[^1] - -Hover it, to see a tooltip. - -[^1]: This is the footnote. - - -## Formatting - -> Go to [documentation](https://zensical.org/docs/authoring/formatting/) - -- ==This was marked (highlight)== -- ^^This was inserted (underline)^^ -- ~~This was deleted (strikethrough)~~ -- H~2~O -- A^T^A -- ++ctrl+alt+del++ - -## Icons, Emojis - -> Go to [documentation](https://zensical.org/docs/authoring/icons-emojis/) - -* :sparkles: `:sparkles:` -* :rocket: `:rocket:` -* :tada: `:tada:` -* :memo: `:memo:` -* :eyes: `:eyes:` - -## Maths - -> Go to [documentation](https://zensical.org/docs/authoring/math/) - -$$ -\cos x=\sum_{k=0}^{\infty}\frac{(-1)^k}{(2k)!}x^{2k} -$$ - -!!! warning "Needs configuration" - Note that MathJax is included via a `script` tag on this page and is not - configured in the generated default configuration to avoid including it - in a pages that do not need it. See the documentation for details on how - to configure it on all your pages if they are more Maths-heavy than these - simple starter pages. - - - - -## Task Lists - -> Go to [documentation](https://zensical.org/docs/authoring/lists/#using-task-lists) - -* [x] Install Zensical -* [x] Configure `zensical.toml` -* [x] Write amazing documentation -* [ ] Deploy anywhere - -## Tooltips - -> Go to [documentation](https://zensical.org/docs/authoring/tooltips/) - -[Hover me][example] - - [example]: https://example.com "I'm a tooltip!" +The documentation is just getting started. diff --git a/docs/markdown.md b/docs/markdown.md deleted file mode 100644 index 6251e13..0000000 --- a/docs/markdown.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -icon: simple/markdown ---- - -asdf - -# Markdown in 5min - -## Headers -``` -# H1 Header -## H2 Header -### H3 Header -#### H4 Header -##### H5 Header -###### H6 Header -``` - -## Text formatting -``` -**bold text** -*italic text* -***bold and italic*** -~~strikethrough~~ -`inline code` -``` - -## Links and images -``` -[Link text](https://example.com) -[Link with title](https://example.com "Hover title") -![Alt text](image.jpg) -![Image with title](image.jpg "Image title") -``` - -## Lists -``` -Unordered: -- Item 1 -- Item 2 - - Nested item - -Ordered: -1. First item -2. Second item -3. Third item -``` - -## Blockquotes -``` -> This is a blockquote -> Multiple lines ->> Nested quote -``` - -## Code blocks -```` -```javascript -function hello() { - console.log("Hello, world!"); -} -``` -```` - -## Tables -``` -| Header 1 | Header 2 | Header 3 | -|----------|----------|----------| -| Row 1 | Data | Data | -| Row 2 | Data | Data | -``` - -## Horizontal rule -``` ---- -or -*** -or -___ -``` - -## Task lists -``` -- [x] Completed task -- [ ] Incomplete task -- [ ] Another task -``` - -## Escaping characters -``` -Use backslash to escape: \* \_ \# \` -``` - -## Line breaks -``` -End a line with two spaces -to create a line break. - -Or use a blank line for a new paragraph. -``` diff --git a/zensical.toml b/zensical.toml index 7515b47..1f5779a 100644 --- a/zensical.toml +++ b/zensical.toml @@ -6,21 +6,6 @@ site_author = "Servala" copyright = "© 2025 Servala" docs_dir = "docs" dev_addr = "localhost:2020" -#repo_url = "https://servala.app.codey.ch/servala/documentation" -#repo_name = "servala/documentation" -#edit_uri = "_edit/main/docs/" -nav = [ - {"Introduction" = "index.md"}, - {"Architecture" = [ - "markdown.md", - ]}, - {"End-User" = [ - "markdown.md", - ]}, - {"ADRs" = [ - "markdown.md", - ]} -] [project.theme] language = "en"