Dmitry V. Levin
e347d53ace
docs: fix grammar a bit
2023-01-23 22:52:34 +00:00
Dmitry V. Levin
d8b67e05fb
docs: fix a few typos
2023-01-23 22:52:34 +00:00
Yu Watanabe
0b0cdb1652
doc: drop remaining references to LGTM.com
2022-09-23 18:29:22 +09:00
Zbigniew Jędrzejewski-Szmek
e1c52cb271
docs/ARCHITECTURE: mention src/fundamental/ and add more details
2022-06-30 11:02:13 +02:00
Benjamin Franzke
5c90c67a34
docs: use relative links
...
Allows for links to work both on systemd.io (or forks) and
when viewed on https://github.com/systemd/systemd/tree/main/docs
Note that the markdown links are converted by jekyll-relative-links[1]
to html. This plugin is enabled by default on github pages[2][3].
Due to a bug in jekyll-relative-links – see
https://github.com/benbalter/jekyll-relative-links/issues/61 –
we need to avoid line-wrapped links when using relative markdown links.
[1] https://github.com/benbalter/jekyll-relative-links
[2] https://github.blog/2016-12-05-relative-links-for-github-pages/
[3] https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#plugins
2022-05-18 20:34:10 +02:00
Benjamin Franzke
818e46ae7c
docs: avoid multiple first-level headlines
...
One document should only contain one main
headline, both for structuring and for
visual reasons.
Relevant cases found via:
git grep -A2 '^# ' docs/
2022-05-17 23:00:18 +02:00
Zbigniew Jędrzejewski-Szmek
c04361d725
docs/ARCHITECTURE: describe fuzzer locations and use
2022-05-08 17:53:56 +02:00
Zbigniew Jędrzejewski-Szmek
3e8caa34d6
docs: use lowercase "qemu" and other minor tweaks to test docs
...
We used both "qemu" and "QEMU", let's use the lower-case version everywhere
since it's also the name of the binary and the version that people are
most familiar with.
The stuff under test/ is not only for the integeration tests, but also
for various other test-related stuff, so adjust the docs a bit.
2022-05-04 12:58:43 +02:00
Zbigniew Jędrzejewski-Szmek
c656265d8f
docs: say that fuzzer input samples should have short names
2022-05-04 12:58:43 +02:00
Zbigniew Jędrzejewski-Szmek
0aff7b7584
docs: add spdx tags to all .md files
...
I have no idea if this is going to cause rendering problems, and it is fairly
hard to check. So let's just merge this, and if it github markdown processor
doesn't like it, revert.
2021-09-27 09:19:02 +02:00
Luca Boccassi
76ab98fa2b
docs: generic info about adding directives in ARCHITECTURE.md
2021-09-14 13:55:05 +01:00
Zbigniew Jędrzejewski-Szmek
771bdb6aae
docs/ARCHITECTURE: more markup and unicode
2021-06-04 10:51:19 +02:00
Lennart Poettering
00d06c996d
docs: use uppercase letters in title
...
We usually do it that way, do so here, too.
2021-06-04 10:34:56 +02:00
Luca Boccassi
2ecce1f1a8
docs: add ARCHITECTURE.md with code map
...
Initial and coarse version of a code map, useful for people getting
started and looking at the repository for the first time.
2021-06-03 22:14:19 +02:00
