diff --git a/docs/authoring/code-blocks.md b/docs/authoring/code-blocks.md index 9b8fc25..a50898e 100644 --- a/docs/authoring/code-blocks.md +++ b/docs/authoring/code-blocks.md @@ -217,7 +217,7 @@ Additional selectors can be set per-language: ``` toml [project.extra.annotate] - json: [".s2"] # (1)! + json = [".s2"] # (1)! ``` 1. [`.s2`][s2] is the name of the lexeme that [Pygments] generates for diff --git a/docs/authoring/images.md b/docs/authoring/images.md index c6fae52..5320337 100644 --- a/docs/authoring/images.md +++ b/docs/authoring/images.md @@ -118,7 +118,7 @@ but it's always possible to use the [Markdown in HTML] extension with literal
- + placeholder image
Image caption
@@ -144,7 +144,7 @@ browsers without support: ```
- + placeholder image
[lazy-loading]: https://caniuse.com/#feat=loading-lazy-attr diff --git a/docs/community/contribute/index.md b/docs/community/contribute/index.md index 0b1da76..f72e170 100644 --- a/docs/community/contribute/index.md +++ b/docs/community/contribute/index.md @@ -217,7 +217,7 @@ clarity, rather than automated outputs. ### LLM-generated issues We are seeing an increasing number of bug reports, change requests and pull -requests generated with large language models (LLMs) that are not a carefully +requests generated with large language models (LLMs) that are not carefully reviewed or edited before submitting. LLM-generated reports are often verbose, unfocused, and rarely adhere to our diff --git a/docs/community/faqs.md b/docs/community/faqs.md index 0120ce8..874a040 100644 --- a/docs/community/faqs.md +++ b/docs/community/faqs.md @@ -103,7 +103,7 @@ Markdown extensions work in Zensical as they do in MkDocs since we use the same Python Markdown parser. You just need to install the Markdown extension into your Python (virtual) environment and [configure it]. - [configure it]: https://zensical.org/docs/setup/extensions/ + [configure it]: https://zensical.org/docs/setup/extensions/about/ ### Why can I not use absolute links with Zensical? diff --git a/docs/community/how-we-work.md b/docs/community/how-we-work.md index 1ff9de6..fdabe00 100644 --- a/docs/community/how-we-work.md +++ b/docs/community/how-we-work.md @@ -151,26 +151,22 @@ sequenceDiagram complex requirements and workflows of professional users. While public discussions in Open Source projects often circle around specific features and implementation details, we use this space to have higher-level discussions - about the [opportunities] we need Zensical to address, on the unmet needs and + about the opportunities we need Zensical to address, on the unmet needs and pain points of people who work with it every day. We also offer private channels and NDAs to discuss confidential matters. - [opportunities]: https://zensical.org/spark/methodology/#stage-1-opportunities - 6. Once we have established a thorough understanding of the opportunity space, we will produce [proposals] for possible solutions. We explore different approaches together with our members in Zensical Spark, to ensure that all options and trade-offs have been considered. - [proposals]: https://zensical.org/spark/methodology/#stage-2-proposals + [proposals]: https://zensical.org/spark/proposals -7. From the exploration proposals we distill a [design document] that provides a +7. From the exploration proposals we distill a design document that provides a clear definition of the opportunities it addresses, alternative solutions that were considered, details of designs, scope, and key implementation decisions as well as identified risks and mitigation strategies. - [design document]: https://zensical.org/spark/methodology/#stage-3-design - 8. We elicit feedback from members in Zensical Spark and iterate over the process as needed. @@ -222,5 +218,3 @@ sequenceDiagram * Discussions within Zensical Spark organized to elicit contributions from groups of users with complex requirements and workflows. - - diff --git a/docs/create-your-site.md b/docs/create-your-site.md index e17e632..9074b49 100644 --- a/docs/create-your-site.md +++ b/docs/create-your-site.md @@ -13,13 +13,13 @@ your project to be located and enter: [installed]: get-started.md -``` +``` sh zensical new . ``` This creates the following structure: -``` .sh +``` text . ├─ .github/workflows │ └─ docs.yml diff --git a/docs/customization.md b/docs/customization.md index 2708952..8405c90 100644 --- a/docs/customization.md +++ b/docs/customization.md @@ -296,7 +296,7 @@ The `overrides` directory is also the place for adding a 404 error page, which can be configured as a fallback in your web server. If you set `custom_dir` to `overrides`, use the following layout: -``` +``` text ├─ overrides/ │ └─ 404.html └─ zensical.toml diff --git a/docs/get-started.md b/docs/get-started.md index 01cb726..a001d1c 100644 --- a/docs/get-started.md +++ b/docs/get-started.md @@ -101,7 +101,7 @@ your `pyproject.toml`, use: [uv]: https://docs.astral.sh/uv/ -``` +``` sh uv init uv add --dev zensical uv run zensical diff --git a/docs/setup/versioning.md b/docs/setup/versioning.md index f3735c3..45210c9 100644 --- a/docs/setup/versioning.md +++ b/docs/setup/versioning.md @@ -17,7 +17,7 @@ solution until we introduce [native versioning support]. We provide a fork of [mike] that you can install with `pip`: -``` +``` sh pip install git+https://github.com/squidfunk/mike.git ```