Commit Graph

37 Commits

Author SHA1 Message Date
Sebastian Poxhofer 9a27d7aa78 ci(prettier): add prettier plugin for admonitions (#43615)
* ci: add local mkdocs-admonitions plugin for prettier to allow admonition preservation

* docs: remove uses of `prettier-ignore` for admonitions

* test: rather use await expect

* chore: use named group exclusively
2026-05-27 09:39:52 +00:00
Jamie Tanna 4b0146ab7b docs: use 2-space indentation for Markdown (#43537)
As noted in #39090, MkDocs requires 4 spaces for indentation (in
particular, for nested lists) whereas our Prettier/markdownlint
configuration expects 2 spaces.

This means that when trying to use i.e. nested lists, we need to ignore
prettier and markdownlint, otherwise it fails.

To handle this, we can add a Markdown hook to override the indentation
level to 2 spaces.

This also requires we update:

- admonitions
- indented text in `index.md`

Co-authored-by: Claude Sonnet 4.6 <jamie.tanna+claude-code@mend.io>
2026-05-26 09:05:42 +00:00
RahulGautamSingh ff27ebee2b docs: use unicode arrow (→) instead of ASCII (->) (#42896)
* chore(docs): use unicode arrow (→) instead of ASCII (->)

* more changes
2026-04-27 07:11:16 +00:00
Laust Rud Jacobsen a67d6af6ac docs(npm-unpublish): Correct npm unpublish time frame 24h -> 72h (#39941)
docs(npm): Correct npm unpublish time frame in documentation

Updated the time frame for npm package unpublishing from 24 to 72 hours for accuracy. Updating link to where the policy is described.
2025-12-15 08:46:46 +00:00
HonkingGoose 66e097b784 docs(dependency pinning): better alt text for images (#29350) 2024-05-30 19:05:44 +00:00
RahulGautamSingh 14899d836d docs: typos and american spellings (#28215)
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
2024-04-04 07:16:15 +00:00
HonkingGoose 6540ff7347 docs(dependency pinning): drop reference to motto (#27746) 2024-03-06 14:14:49 +00:00
Ілля Мазуряк f70f0c82be feat(changelogs): Migrate fetchReleaseNotes to fetchChangeLogs (#25364)
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: Rhys Arkins <rhys@arkins.net>
2023-11-05 18:32:59 +00:00
HonkingGoose 76c9c63417 docs: use simple words (#23989) 2023-08-22 14:07:21 +02:00
HonkingGoose f9f9a23446 docs(dependency pinning): improve quote (#23402) 2023-07-19 09:15:51 +00:00
HonkingGoose 71d082d16f docs: use relative URLs in more places (#22516) 2023-05-31 15:52:30 +00:00
HonkingGoose b08fa0cf8b docs: drop weasel words (#22165)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
2023-05-29 08:20:40 +00:00
Michael Markey caa2a76a5e docs(dependency-pinning): typo in recommendation (#19726) 2023-01-08 21:06:11 +00:00
HonkingGoose a49e206dd3 docs: use input-neutral verbs (#19165) 2022-11-30 10:37:00 +01:00
HonkingGoose 12f643d362 docs: lazy-load images (#17565) 2022-09-02 13:30:49 +02:00
HonkingGoose 5f21c63ba5 docs: replace word therefore, plus other small changes (#15694) 2022-06-02 16:58:52 +02:00
HonkingGoose 82a219f3e9 docs: fix typos (#15542) 2022-05-11 09:53:15 +00:00
HonkingGoose ea410daf6e docs: remove link to file on GitHub (#15007) 2022-04-07 12:00:36 +02:00
HonkingGoose 41fd7fbf46 docs: replace however with but (#14707)
Co-authored-by: Anne Stellingwerf <astellin@opentext.com>
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: Rhys Arkins <rhys@arkins.net>
2022-03-28 19:25:49 +00:00
HonkingGoose 315f4f689a docs: replace attempt with try (#14689) 2022-03-16 14:54:30 +01:00
HonkingGoose 5a52b04c96 docs: replace contain(s) with has or have (#14692) 2022-03-16 14:50:20 +01:00
HonkingGoose a7903a4de2 docs: replace receive with get (#14073) 2022-02-07 15:53:22 +01:00
HonkingGoose b1e9ee1828 docs(dependency-pinning): use admonition (#13895) 2022-01-28 19:35:23 +01:00
HonkingGoose 013189bf18 docs(dependency-pinning): use document fragment (#13464) 2022-01-10 14:45:36 +01:00
HonkingGoose 4871f41428 docs: create page for key concept scheduling (#11278) 2021-08-30 08:20:02 +00:00
HonkingGoose 977357f661 docs: fix broken link (#10788) 2021-07-12 11:31:36 +02:00
HonkingGoose 75b5e9d6b3 docs: master branch -> main branch, default branch -> base branch (#9808)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
2021-05-03 07:34:15 +00:00
HonkingGoose cf460434a0 build: migrate from master branch to main (#8663) 2021-04-22 14:32:12 +00:00
Rhys Arkins c17e40993a docs: lint 2021-03-09 23:21:38 +01:00
HonkingGoose b391a55668 docs: tidy up dependency pinning essay (#7911) 2020-12-10 15:13:02 +01:00
HonkingGoose 8560b5d657 docs: remove punctuation from end of (un)ordered lists (#7669)
* fix bad indentation

* remove punctuation from end of (un)ordered lists
2020-11-06 12:00:57 +01:00
HonkingGoose 32dd490672 docs: use one sentence per line (#7625) 2020-11-02 09:52:37 +01:00
HonkingGoose 89346338cb docs: fix capitalization/style errors (#7532)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
2020-10-23 17:42:57 +02:00
HonkingGoose 76ba198e72 docs: use proper capitalization for noun JavaScript (#7528) 2020-10-23 15:30:15 +02:00
Josh Soref 9aff7a955f chore: spelling (#7499) 2020-10-20 08:49:28 +02:00
Jamie Magee 84972575d5 docs: use https for external links (#4725) 2019-10-25 10:48:04 +02:00
Rhys Arkins 8e97958dd1 docs: relocate website docs 2019-09-09 04:28:25 +02:00