Full documentation repository for Mastodon
Go to file
Moritz 5ebc8ad418
Replace and fix broken links with hugos relref (#801)
As discussed in #764 there are quite a lot of outdated links in the
mastodon documentation. In basically all cases this was resolved by
simply wrapping the old plain markdown link in hugos `relref`
function[^0].

While quite a lot of links on the `/zh-cn/` also appear to be broken,
these can not be fixed by just wrapping them in `relref`[^0]. Those are
all links to `/spec/` subpages which are just not translated to `/zh-cn/`
version. Therefore, `/zh-cn/spec/` has been excluded from the automated
checking as described in the next section.

The page has been checked using the linkchecker[^1] utility. One process
is running `hugo serve` in order to see all changes in real time and
notice errors directly in your browser. In a separate command prompt the
command `linkchecker http://localhost:1313 --ignore-url=/zh-cn/spec` is
being fired up. Note the `--ignore-url=/zh-cn/spe` to exclude the just
not existing parts of the page as mentioned in the previous paragraph.

There still is some ToDo on the table since quite a lot of the anchors
appear to not be set or at least differ from previous versions. One
example: on `/client/authorized/` is a link to
`/client/token/#creating-our-application` while the id of referenced
heading is `app`. These changes **do not** fix those Issues as it would
require way more time.

[^0]: https://gohugo.io/functions/relref/
[^1]: https://github.com/linkchecker/linkchecker

Close #764
2020-08-10 23:01:50 +02:00
.github/workflows Setup GitHub Actions for deploying to docs.joinmastodon.org 2020-01-05 22:19:44 +01:00
archetypes Initial commit 2018-09-23 00:14:25 +02:00
assets Update anchors, line breaks, tootctl options (#745) 2020-01-12 14:11:56 +01:00
content Replace and fix broken links with hugos relref (#801) 2020-08-10 23:01:50 +02:00
data Update documentation with contents by twrnh 2020-01-04 10:33:16 +01:00
i18n Add chinese translation (#772) 2020-05-20 20:54:12 +02:00
layouts update for 3.1 (#785) 2020-07-01 02:11:40 +02:00
static Update documentation with contents by twrnh 2020-01-04 10:33:16 +01:00
.gitignore Initial commit 2018-09-23 00:14:25 +02:00
.gitlab-ci.yml Update documentation with contents by twrnh 2020-01-04 10:33:16 +01:00
LICENSE Add LICENSE 2018-10-21 04:03:53 +02:00
README.md Add README 2020-01-05 20:26:27 +01:00
config.toml update for 3.1 (#785) 2020-07-01 02:11:40 +02:00

README.md

Mastodon

View the documentation at https://docs.joinmastodon.org