Add a subcategories layer for guides & cookbooks #2612
Conversation
Gedochao
force-pushed
the
docs/clean-up-categories
branch
from
d92e18c
to
5aa494d
Compare
Gedochao
force-pushed
the
docs/clean-up-categories
branch
from
5aa494d
to
4eaaebc
Compare
| @@ -3,7 +3,7 @@ title: IntelliJ IDEA setup | |||
| sidebar_position: 11 | |||
| --- | |||
|
|
|||
| import {ChainedSnippets} from "../../src/components/MarkdownComponents.js"; | |||
| import {ChainedSnippets} from "../../../src/components/MarkdownComponents.js"; | |||
There was a problem hiding this comment.
Would it make sense to join the Intellij cookbooks into one?
There was a problem hiding this comment.
we could, but that would make it complex enough to make it a guide.
There was a problem hiding this comment.
also, besom's contributing doc seems to be linking to one of them, if we end up merging these into a guide, then we should update it in there: https://github.com/VirtusLab/besom/blob/develop/CONTRIBUTING.md#intellij-setup
There was a problem hiding this comment.
Should we join instant startup with scripts?
There was a problem hiding this comment.
similar to the IntelliJ ones, it'd make the result a guide rather than a cookbook
| @@ -15,38 +15,41 @@ the [cookbooks section](../cookbooks/intro.md). | |||
|
|
|||
| These few guides are a good starting point when learning how to use Scala CLI. | |||
|
|
|||
| - [Configuration](./configuration.md) - learn how to configure various options, and what configuration styles are best | |||
| - [Configuration](introduction/configuration.md) - learn how to configure various options, and what configuration styles are best | |||
There was a problem hiding this comment.
It's hard to figure out now, what is the difference between a guide and cook book. Isn't it basically the same?
There was a problem hiding this comment.
Good point, the difference is quite slim, maybe we should consider merging them?
Although some of them won't really fit the guides, those could be left in a separate Examples section.
WDYT?
Of course it's for a potential separate ticket.
There was a problem hiding this comment.
I believe the idea is for cookbooks to be simple step-by-step posts with clear examples, while guides are meant to be more in-depth.
Perhaps Examples would be a more readable category, rather than cookbooks...
But then, we might need a lot more of them, cause such a change would make more people to look for examples in there, rather than in command docs or guides.
There was a problem hiding this comment.
alternatively, we could indeed merge them and only have guides... dunno, might be worth discussing it
Relevant ticket: #2592
Guides & cookbooks are now divided into subcategories in the sidebar.
The division is done according to the existing index docs.
Some recent docs haven't been present in the indexes, so I added them.
I also cleaned up some other stuff, like consistently using relative links where able (so that IDEs can do the busywork for us when we move docs around) and other minor things.