feat: Update preparation section#54
Conversation
|
Some notes before I go into this more in-depth later:
|
|
Addressed most of the feedback. Whilst looking through the components I did find the Steps component. I don't want to keep adding new features if this will cause any styling or desired theming issues (as the more theme components you add the less portable the documentation becomes) but the effect of it does looks quite good I think:
So if there is a desire, I could add it in. Or do it in a later PR. I think what might be worth it for the documentation as a whole is to make a styleguide or guidelines to make sure that things remain consistent. |
I had actually meant to play with these components but never got to it. IMO this is a perfect fit. I do plan to make a page dedicated to hacking on these docs, if for no other reason than the README currently holds an entire translation guide that should have its own home. This sounds like a good fit for that. |
|
OK, all existing feedback/questions should have been addressed now |
|
After some digging and while we're waiting for Owen, I figured out a less hacky solution for the Badge using HTML. <div>
<Badge size="large" text="💙 Thanks for contributing to Terra!" />
</div> |

As discussed on the Terra Discord.
This PR makes some changes to the the "Preparation" section of the "Getting started" doc. This was created from my own experience of "going in blind" in Terra (and rpm) packaging.
The focus in this section is mostly on some layout changes and adding some additional helping formats into the existing wording rather than attempting to fundamentally change the content.
It does however feature a few changes in the document as a whole as this was necessary to maintain a consistent structure or style.
The below is a list of changes that might not be obvious as to why I changed them, with my justifications for changing them:
TabsandTabItemStarlight component to use as a switcher to reduce the length of the instructions on the pageh1and the rest are update to logically fit in<code>tags to a code fence format to match the install page and to automatically get the theme decorations. This also makes it easier to contribute as the highlighter takes care of the colours rather than explicitly setting them with ansi codesshfromshellto match the install page precedentAddedtype=infoattribute to asides if missing (infois default if not specified)