Skip to content

Commit 0bf79a7

Browse files
authored
fix: fix various docs issues
Signed-off-by: Timothée Mazzucotelli <dev@pawamoy.fr>
1 parent cb3d9f2 commit 0bf79a7

9 files changed

Lines changed: 13 additions & 19 deletions

File tree

docs/authoring/code-blocks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ Additional selectors can be set per-language:
217217

218218
``` toml
219219
[project.extra.annotate]
220-
json: [".s2"] # (1)!
220+
json = [".s2"] # (1)!
221221
```
222222

223223
1. [`.s2`][s2] is the name of the lexeme that [Pygments] generates for

docs/authoring/images.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ but it's always possible to use the [Markdown in HTML] extension with literal
118118

119119
<div class="result">
120120
<figure>
121-
<img src="https://dummyimage.com/600x400/f5f5f5/aaaaaa?text=–%20Image%20–" width="300" />
121+
<img src="https://dummyimage.com/600x400/f5f5f5/aaaaaa?text=–%20Image%20–" width="300" alt="placeholder image" />
122122
<figcaption>Image caption</figcaption>
123123
</figure>
124124
</div>
@@ -144,7 +144,7 @@ browsers without support:
144144
```
145145

146146
<div class="result" markdown>
147-
<img src="https://dummyimage.com/600x400/f5f5f5/aaaaaa?text=–%20Image%20–" width="300" />
147+
<img src="https://dummyimage.com/600x400/f5f5f5/aaaaaa?text=–%20Image%20–" width="300" alt="placeholder image" />
148148
</div>
149149

150150
[lazy-loading]: https://caniuse.com/#feat=loading-lazy-attr

docs/community/contribute/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ clarity, rather than automated outputs.
217217
### LLM-generated issues
218218

219219
We are seeing an increasing number of bug reports, change requests and pull
220-
requests generated with large language models (LLMs) that are not a carefully
220+
requests generated with large language models (LLMs) that are not carefully
221221
reviewed or edited before submitting.
222222

223223
LLM-generated reports are often verbose, unfocused, and rarely adhere to our

docs/community/faqs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Markdown extensions work in Zensical as they do in MkDocs since we use the same
103103
Python Markdown parser. You just need to install the Markdown extension into
104104
your Python (virtual) environment and [configure it].
105105

106-
[configure it]: https://zensical.org/docs/setup/extensions/
106+
[configure it]: https://zensical.org/docs/setup/extensions/about/
107107

108108
### Why can I not use absolute links with Zensical?
109109

docs/community/how-we-work.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -151,26 +151,22 @@ sequenceDiagram
151151
complex requirements and workflows of professional users. While public
152152
discussions in Open Source projects often circle around specific features and
153153
implementation details, we use this space to have higher-level discussions
154-
about the [opportunities] we need Zensical to address, on the unmet needs and
154+
about the opportunities we need Zensical to address, on the unmet needs and
155155
pain points of people who work with it every day. We also offer private channels
156156
and NDAs to discuss confidential matters.
157157

158-
[opportunities]: https://zensical.org/spark/methodology/#stage-1-opportunities
159-
160158
6. Once we have established a thorough understanding of the opportunity space,
161159
we will produce [proposals] for possible solutions. We explore different
162160
approaches together with our members in Zensical Spark, to ensure that all
163161
options and trade-offs have been considered.
164162

165-
[proposals]: https://zensical.org/spark/methodology/#stage-2-proposals
163+
[proposals]: https://zensical.org/spark/proposals
166164

167-
7. From the exploration proposals we distill a [design document] that provides a
165+
7. From the exploration proposals we distill a design document that provides a
168166
clear definition of the opportunities it addresses, alternative solutions
169167
that were considered, details of designs, scope, and key implementation
170168
decisions as well as identified risks and mitigation strategies.
171169

172-
[design document]: https://zensical.org/spark/methodology/#stage-3-design
173-
174170
8. We elicit feedback from members in Zensical Spark and iterate over the
175171
process as needed.
176172

@@ -222,5 +218,3 @@ sequenceDiagram
222218

223219
* Discussions within Zensical Spark organized to elicit contributions from
224220
groups of users with complex requirements and workflows.
225-
226-

docs/create-your-site.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ your project to be located and enter:
1313

1414
[installed]: get-started.md
1515

16-
```
16+
``` sh
1717
zensical new .
1818
```
1919

2020
This creates the following structure:
2121

22-
``` .sh
22+
``` text
2323
.
2424
├─ .github/workflows
2525
│ └─ docs.yml

docs/customization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ The `overrides` directory is also the place for adding a 404 error page, which
296296
can be configured as a fallback in your web server. If you set `custom_dir` to
297297
`overrides`, use the following layout:
298298

299-
```
299+
``` text
300300
├─ overrides/
301301
│ └─ 404.html
302302
└─ zensical.toml

docs/get-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ your `pyproject.toml`, use:
101101

102102
[uv]: https://docs.astral.sh/uv/
103103

104-
```
104+
``` sh
105105
uv init
106106
uv add --dev zensical
107107
uv run zensical

docs/setup/versioning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ solution until we introduce [native versioning support].
1717

1818
We provide a fork of [mike] that you can install with `pip`:
1919

20-
```
20+
``` sh
2121
pip install git+https://github.com/squidfunk/mike.git
2222
```
2323

0 commit comments

Comments
 (0)