Skip to content

Commit bed1ca4

Browse files
committed
Tweak docs
1 parent e754276 commit bed1ca4

3 files changed

Lines changed: 7 additions & 6 deletions

File tree

docs/quickstart/migrate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Add a script that will automatically populate a page for each type that exists i
7070

7171
This script is picked up to run seamlessly as part of the normal site build, because we had configured the [`gen-files` plugin](https://github.com/oprypin/mkdocs-gen-files), which is already explained above.
7272

73-
??? tip
73+
!!! tip
7474
Find more advanced examples of such scripts in [Showcase](../showcase.md).
7575

7676
## Add a normal page

docs/showcase.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ Here are some websites using this doc generator:
1515

1616
## Athena Framework
1717

18-
* [Home page](http://beta.athenaframework.org/)[Website repository](https://github.com/oprypin/athena-website)
19-
* [**Generated API docs page**](http://beta.athenaframework.org/Serializer/Context/)[gen_doc_stubs.py](https://github.com/oprypin/athena-website/blob/mkdocstrings/gen_doc_stubs.py)
20-
* [**Partly inferred nav**](https://github.com/oprypin/athena-website/blob/mkdocstrings/docs/SUMMARY.md)
21-
* [Custom source directories](https://github.com/oprypin/athena-website/blob/mkdocstrings/mkdocs.yml)[Multi-repo setup](https://github.com/oprypin/athena-website/blob/mkdocstrings/shard.lock)
18+
* [Home page](https://athenaframework.org/)[Website repository](https://github.com/athena-framework/website)
19+
* [**Generated API docs page**](https://athenaframework.org/Serializer/Context/)[gen_doc_stubs.py](https://github.com/athena-framework/website/blob/master/gen_doc_stubs.py)
20+
* [**Partly inferred nav**](https://github.com/athena-framework/website/blob/master/docs/SUMMARY.md)
21+
* [Custom source directories](https://github.com/athena-framework/website/blob/master/mkdocs.yml)[Multi-repo setup](https://github.com/athena-framework/website/blob/master/shard.lock)
2222

2323
## CrSFML
2424

examples/migrated/docs/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22

33
Welcome to my project!
44

5-
Make sure to check out the [API documentation](Foo/), particularly [Foo#g(bar)][].
5+
Make sure to check out the [API documentation](Foo/),
6+
particularly [Foo#g(bar)][].

0 commit comments

Comments
 (0)