Add Getting started tutorial and link it between pages #64
Conversation
|
@sovdeeth please, could you consider approval of these changes too? |
please don't tag people for reviews, we all get notifications about new prs and will review when we have time. |
|
Sorry, sure, I was under impression that this docs project is forgotten… Since there are 7 open Pull Requests. I know you do it in your free time, in good will. 🙏 |
|
Is there anything I can do for you to simplify review? Should I add screenshots? |
| 3. The `docs/` directory will be created _(if not created already)_ in `plugins/Skript` containing the website's files. | ||
| 4. Open `index.html` and browse the documentation. | ||
| 5. _(Optionally)_ Add this system property `-Dskript.forceregisterhooks` in your server startup script (before the -jar property) to force generating hooks docs. | ||
| 2. Launch the server (the [Paper](https://papermc.io/), which is a fork of Spigot, is recommended). |
There was a problem hiding this comment.
I don't think we should specify such things here in case it gets changed later.
| 2. Launch the server (the [Paper](https://papermc.io/), which is a fork of Spigot, is recommended). | |
| 2. Once created, launch the Minecraft server |
There was a problem hiding this comment.
If I may, I would disagree. I found the information in the readme. I'm new to MC development, and I Installed a different and incompatible server because I was missing this information.
There was a problem hiding this comment.
Nice work! just couple notes:
- Use "Minecraft server" instead of "Paper server"
- Prefer using single paragraphs with multiline text than multiple single paragraphs
<p class="subtitle">
Skript requires Spigot to work. You heard it right, CraftBukkit does not work. <a
href="https://papermc.io/">Paper</a>, which is a fork of Spigot, is recommended; it is required for some parts of
Skript to be available.
- </p>
- <p class="subtitle">
Skript supports only the latest patch versions of Minecraft. For example, this means that if 1.16.5 is supported,
then 1.16.4 is not. Testing with all old patch versions is not feasible for us.
</p>
<p class="subtitle">
Skript requires Spigot to work. You heard it right, CraftBukkit does not work. <a
href="https://papermc.io/">Paper</a>, which is a fork of Spigot, is recommended; it is required for some parts of
Skript to be available.
+ <br>
Skript supports only the latest patch versions of Minecraft. For example, this means that if 1.16.5 is supported,
then 1.16.4 is not. Testing with all old patch versions is not feasible for us.
</p>There was a problem hiding this comment.
Done. I replaced "Paper server", but two occurrences where I would like to leave the "Paper":
- "Paper, which is a fork of Spigot",
- "Paper tutorial"
... If you don't mind.
There was a problem hiding this comment.
For me, it was a pain to figure out that I needed to use the "Spigot compatible" server. If you are not against, I would keep this information wherever it is possible.
docs/templates/index.html
Outdated
| <div id="info" class="grid-container padding"> | ||
| <div class="grid-item"> | ||
| </div> | ||
| <div class="grid-item"> | ||
| </div> | ||
| <div class="grid-item"> | ||
| <p class="box-title">Next step</p> | ||
| <p class="box placeholder"><a class="link" href="getting-started.html">Getting started</a></p> | ||
| </div> | ||
| </div> |
There was a problem hiding this comment.
Let's make this take the full width instead
| <div id="info" class="grid-container padding"> | |
| <div class="grid-item"> | |
| </div> | |
| <div class="grid-item"> | |
| </div> | |
| <div class="grid-item"> | |
| <p class="box-title">Next step</p> | |
| <p class="box placeholder"><a class="link" href="getting-started.html">Getting started</a></p> | |
| </div> | |
| </div> | |
| <p class="box-title">Next step</p> | |
| <p class="box placeholder">Visit the <a class="link" href="getting-started.html">Getting started</a> page to learn more on how to install Skript and create your first script!</p> |
There was a problem hiding this comment.
Okay, let me check this first. I'll compare the results.
docs/templates/tutorials.html
Outdated
There was a problem hiding this comment.
Let's remove these changes as we have other plans for a new design for this page :)
Co-authored-by: Ayham Al Ali <20037329+AyhamAl-Ali@users.noreply.github.com> Co-authored-by: Efnilite <35348263+Efnilite@users.noreply.github.com>
Related to #12: