Update links, minor additions in docs

Author: oprypin

README.md

@@ -10,6 +10,8 @@
 
 *mkdocstrings-crystal* allows you to insert API documentation (generated from [Crystal][]'s source code and doc comments) as part of any page on a [MkDocs][] site.
 
+[See it in action][showcase].
+
 To install it, run (possibly in a [virtualenv][]):
 
 ```shell
@@ -62,6 +64,7 @@ mkdocs serve  # live preview
 
 [crystal]: https://crystal-lang.org/
 [mkdocs]: https://www.mkdocs.org/
-[mkdocstrings]: https://pawamoy.github.io/mkdocstrings/
+[mkdocstrings]: https://mkdocstrings.github.io/
 [virtualenv]: https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment
 [documentation site]: https://mkdocstrings.github.io/crystal/
+[showcase]: https://mkdocstrings.github.io/crystal/showcase.html

docs/README.md

@@ -1,22 +1,23 @@
 # mkdocstrings-crystal
 
-Crystal language doc generator for [MkDocs][], via [mkdocstrings][].
+**[Crystal][] language doc generator for [MkDocs][], via [mkdocstrings][].**
 
 ## Installation
 
 ```console
 $ pip install mkdocstrings-crystal
 ```
 
-[Continue with **quickstart**](quickstart/index.md).
+[Continue with **quickstart**](quickstart/index.md).  
+Or use [the migration guide](quickstart/migrate.md) for a low-effort transition from `crystal doc`.
 
 ## Introduction
 
 Crystal has [its own easy-to-use generator of API documentation sites](https://crystal-lang.org/reference/using_the_compiler/#crystal-docs), but it's very rigid, as it doesn't attempt to do anything other than API documentation, so [these sites](https://crystal-lang.org/api/0.35.1/Process.html) end up being very isolated and prevent the author from presenting some kind of *story* about using their library.
 
 Instead, this plugin is all about that *story*. It's very inspiring to look at [Python's documentation for `subprocess`](https://docs.python.org/3/library/subprocess.html), and hard to imagine a world in which this document is just an alphabetic dump of the functions in it.
 
-So (matching the [idea behind *mkdocstrings*](https://pawamoy.github.io/mkdocstrings/usage/) but for Crystal), this allows you to just write textual documentation in Markdown and, in the middle of it, mention any identifier of a Crystal type, method etc., and have its API documentation (signature and doc comment) printed out right there.
+So (matching the [idea behind *mkdocstrings*](https://mkdocstrings.github.io/usage/) but for Crystal), this allows you to just write textual documentation in Markdown and, in the middle of it, mention any identifier of a Crystal type, method etc., and have its API documentation (signature and doc comment) printed out right there.
 
 ## Usage
 
@@ -51,7 +52,7 @@ Then, in any `docs/**/*.md` file, you can **mention a Crystal identifier alone o
 
 -- and in the output this will be replaced with generated API documentation for it, much like Crystal's own doc generator does.
 
-Learn more about this syntax: [in *mkdocstrings* in general](https://pawamoy.github.io/mkdocstrings/usage/) (Crystal specifics are below).
+Learn more about this syntax: [in *mkdocstrings* in general](https://mkdocstrings.github.io/usage/) (Crystal specifics are below).
 
 The auto-replacement, of course, happens as part of a normal MkDocs build process:
 
@@ -64,7 +65,7 @@ $ mkdocs serve  # live preview
 
 The syntax for these "callouts" is almost exactly the same as in Crystal's own doc comments. As you may also know, if you **mention an identifier in backticks within a doc comment (e.g. <code>\`SomeClass#some_method\`</code>)**, Crystal's doc generator will cross-link to it. The same also works seamlessly here, and you don't need to change anything (other than possible edge cases).
 
-But another powerful feature of this plugin is that you can **[cross-reference](https://pawamoy.github.io/mkdocstrings/usage/#cross-references) items like this *anywhere* on the site**, not just in doc comments. But the syntax is **`[SomeClass#some_method][]`** instead. Or `[with custom text][SomeClass#some_method]`. Note, though, that currently this cross-reference syntax is quite rigid, and you need to specify the exact absolute identifier as *mkdocstrings-crystal* determines it. To find that out, you could click on the wanted item in the navigation and then copy the anchor part from the URL bar -- the part after (not including) `#`.
+But another powerful feature of this plugin is that you can **[cross-reference](https://mkdocstrings.github.io/usage/#cross-references) items like this *anywhere* on the site**, not just in doc comments. But the syntax is **`[SomeClass#some_method][]`** instead. Or `[with custom text][SomeClass#some_method]`. Note, though, that currently this cross-reference syntax is quite rigid, and you need to specify the exact absolute identifier as *mkdocstrings-crystal* determines it. To find that out, you could click on the wanted item in the navigation and then copy the anchor part from the URL bar -- the part after (not including) `#`.
 
 ## Usage details
 
@@ -73,5 +74,6 @@ We have been talking about seamlessly inserting Crystal documentation, but where
 Continue to [Configuration](configuration.md).
 
 
+[crystal]: https://crystal-lang.org/
 [mkdocs]: https://www.mkdocs.org/
-[mkdocstrings]: https://pawamoy.github.io/mkdocstrings/
+[mkdocstrings]: https://mkdocstrings.github.io/

docs/assets/style.css

@@ -7,7 +7,7 @@
   font-size: inherit;
 }
 
-/* https://pawamoy.github.io/mkdocstrings/handlers/python/#recommended-style-material */
+/* https://mkdocstrings.github.io/handlers/python/#recommended-style-material */
 
 .doc-contents th, .doc-contents td {
   padding: 0.5em 0.8em !important;

docs/configuration.md

@@ -2,7 +2,7 @@
 
 ## Handler options
 
-(See also: [*mkdocstrings* global options](https://pawamoy.github.io/mkdocstrings/usage/#global-options))
+(See also: [*mkdocstrings* global options](https://mkdocstrings.github.io/usage/#global-options))
 
 ### `crystal_docs_flags:`
 
@@ -16,7 +16,7 @@ A list of command line arguments to pass to `crystal doc`. Mainly used to choose
 :    Set to `true` to also recursively render all `Foo::Sub::Types` whenever rendering a given class `Foo`.
 
 `file_filters:` [list of strings]
-:    If a particular module spans over several files, you might want to choose to render only the sub-items (see `nested_types`) that came from a particular file. These patterns are regular expressions (not anchored) applied to the file path. Negating the patterns is done by starting it with `!` (which is then excluded from the following regex). This is very similar to [what's done in *mkdocstrings*](https://pawamoy.github.io/mkdocstrings/reference/handlers/python/#mkdocstrings.handlers.python.PythonCollector.default_config)
+:    If a particular module spans over several files, you might want to choose to render only the sub-items (see `nested_types`) that came from a particular file. These patterns are regular expressions (not anchored) applied to the file path. Negating the patterns is done by starting it with `!` (which is then excluded from the following regex). This is very similar to [what's done in *mkdocstrings*](https://mkdocstrings.github.io/reference/handlers/python/#mkdocstrings.handlers.python.PythonCollector.default_config)
 
 ### `rendering:`
 

docs/quickstart/index.md

@@ -51,7 +51,7 @@ Let's configure [MkDocs][] with *mkdocstrings-crystal*. Add/merge this config as
     :   Activate the upstream *mkdocstrings* plugin and tell it to collect items from Crystal, not Python, by default.
 
     `watch: [src]`
-    :   Watch a directory for [auto-reload](https://pawamoy.github.io/mkdocstrings/usage/#watch-directories). Assuming the sources are under `src/`.
+    :   Watch a directory for [auto-reload](https://mkdocstrings.github.io/usage/#watch-directories). Assuming the sources are under `src/`.
 
     [`pymdownx.*` extensions](https://facelessuser.github.io/pymdown-extensions/)
     :   Python-Markdown is an "old-school" Markdown parser, and these extensions bring the defaults more in line with what people are used to now.

docs/showcase.md

@@ -8,7 +8,7 @@ Here are some websites using this doc generator:
 ## Tourmaline
 
 * [Home page](https://tourmaline.dev/) ｜ [Repository](https://github.com/protoncr/tourmaline)
-* [Textual docs page with generated references](https://tourmaline.dev/usage/features/handlers/) ｜ [**Source**](https://github.com/protoncr/tourmaline/blob/master/docs/usage/features/handlers.md)
+* [**Textual docs page with generated references**](https://tourmaline.dev/usage/features/handlers/) ｜ [**Source**](https://github.com/protoncr/tourmaline/blob/master/docs/usage/features/handlers.md)
 * [Generated API docs page](https://tourmaline.dev/api_reference/Tourmaline/Client/) ｜ [gen_doc_stubs.py](https://github.com/protoncr/tourmaline/blob/master/docs/gen_doc_stubs.py)
 * [Partly inferred nav](https://github.com/protoncr/tourmaline/blob/master/docs/SUMMARY.md)
 * [**Custom styling**](https://github.com/protoncr/tourmaline/blob/master/docs/stylesheets/extra.css)

docs/troubleshooting.md

@@ -32,8 +32,8 @@ You can always [customize the styles with CSS](styling.md), but make sure you've
 
 ## MkDocs warns me about links to unfound documentation files
 
-[See documentation of *mkdocstrings*](https://pawamoy.github.io/mkdocstrings/troubleshooting/#mkdocs-warns-me-about-links-to-unfound-documentation-files)
+[See documentation of *mkdocstrings*](https://mkdocstrings.github.io/troubleshooting/#mkdocs-warns-me-about-links-to-unfound-documentation-files)
 
 ## Warning: could not find cross-reference target
 
-[See documentation of *mkdocstrings*](https://pawamoy.github.io/mkdocstrings/troubleshooting/#warning-could-not-find-cross-reference-target)
+[See documentation of *mkdocstrings*](https://mkdocstrings.github.io/troubleshooting/#warning-could-not-find-cross-reference-target)