Refactor docs
This MR contains the following changes.
-
Move Doc
component intoindex.ts
-
Consistent component directories -
search
dir is renamed toSearch
-
reference
contains component namedRef
. -
remapper
contains component namedRef
.
-
-
Consistent route nesting -
Created package
routes directory. -
action
contains pages based on the.mdx?
files present. -
remapper
contains pages based on the.mdx?
files present. -
reference
contains pages based on the.mdx?
files present.
-
-
Infer menu items from routes -
Actions -
Remappers -
Reference
-
-
Consistent breadcrumbs -
Breadcrumbs on nested docs page contain link to parent docs page. -
Link to parent pages, do not end with a /
.
-
-
Consistent ordering -
Consistent translations -
Consistent table of contents -
Correctly use plural in section names -
Links to docs are adjusted
Before assigning a reviewer go through the following checklist, and make sure to test your changes manually (if possible).
-
Make sure to read the CONTRIBUTING.md for best practices and guidelines. -
Make sure to put the merge request on draft:
if it's not ready. -
If this merge requests closes an issue, make sure the merge request description contains, closes #the-issue-number. -
If this merge request only relates to an issue, refer to the issue with refs #the-issue-number. -
If there is no related issue, consider adding a description and add labels accordingly. -
If this is a bug fix, consider adding regression tests. -
If this is blocked by another merge request, make sure to make it depend.
TIP: Use ~
in the checklist item (like this - [~]
) to strike it out if it's not applicable.
Edited by Koen Schellingerhout