Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tutorial for commands to Docs site. #4653

Closed
wants to merge 20 commits into from

Conversation

sovdeeth
Copy link
Member

@sovdeeth sovdeeth commented Mar 8, 2022

Description

I'm not fully satisfied with how it looks, and will definitely do a second pass. I'd like feedback before worrying about aesthetics, though, so I'm creating this pr.
I am pretty happy with the content, though one thing I'm worried about is that there may be too many examples in relation to the explaining text. I tend to find examples more useful than explanations, but I'm not sure about everyone else.
I also haven't done anything about navigation, which will be needed for jumping between tutorials.

You can view a version of this site here

I referenced Blueyescat's tutorial on skripthub a lot while creating this, as it's a very good tutorial. I also used (and intend to add more of) the new command examples from #4605.


Target Minecraft Versions: Any
Requirements: None
Related Issues: None

sovdeeth added 2 commits March 8, 2022 17:43
I'm not fully satisfied with how it looks, and will probably do a second pass. I am happy with the content, though, and would like feedback if possible.
I also haven't done anything about navigation, which will be needed for jumping between tutorials.
@AyhamAl-Ali AyhamAl-Ali added documentation Related to Skript's official documentation. enhancement Feature request, an issue about something that could be improved, or a PR improving something. labels Mar 9, 2022
Copy link
Member

@AyhamAl-Ali AyhamAl-Ali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice PR, thank you for this contribution

However, this tutorial should have its own page like commands.html just duplicate test.html and follow its style
The tutorials.html page is the home page of tutorials which will contain all the tutorials (I will PR that soon)

also, Highlight.js has be removed in the next docs PR so don't use it, to highlight your code just use put your code inside this

<div class="box skript-code-block">
# CODE
</div>

You can take a look at the new docs here

I will make another review once it's ready

@sovdeeth
Copy link
Member Author

Alright I'm pretty happy with the state that this is in, if you would be so kind as to give it another once-over, AyhamAl-Ali.

@sovdeeth sovdeeth marked this pull request as ready for review March 12, 2022 04:28
Copy link
Member

@AyhamAl-Ali AyhamAl-Ali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't checked the written content and codes yet but this is some technical notes.
I will make another review regarding the content when I can but another reviewer would be good :D

docs/commands.html Outdated Show resolved Hide resolved
docs/commands.html Outdated Show resolved Hide resolved
docs/commands.html Outdated Show resolved Hide resolved
docs/commands.html Outdated Show resolved Hide resolved
Waiting on response from blueyescat for permission to use snippets from their tutorial, so this PR shouldn't be accepted until that happens.
Copy link
Member

@AyhamAl-Ali AyhamAl-Ali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some minor changes
Well done 👌

docs/commands.html Outdated Show resolved Hide resolved
docs/commands.html Outdated Show resolved Hide resolved
docs/commands.html Outdated Show resolved Hide resolved
docs/commands.html Show resolved Hide resolved
docs/commands.html Outdated Show resolved Hide resolved
docs/commands.html Outdated Show resolved Hide resolved
docs/commands.html Outdated Show resolved Hide resolved
docs/commands.html Outdated Show resolved Hide resolved
docs/commands.html Outdated Show resolved Hide resolved
docs/commands.html Show resolved Hide resolved
@sovdeeth sovdeeth requested a review from AyhamAl-Ali March 21, 2022 20:08
Copy link
Member

@AyhamAl-Ali AyhamAl-Ali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Well done 👌
Another review would be nice

Copy link
Member

@APickledWalrus APickledWalrus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is awesome! Just a few minor things 🙂

docs/commands.html Outdated Show resolved Hide resolved
docs/commands.html Outdated Show resolved Hide resolved
docs/commands.html Outdated Show resolved Hide resolved
docs/commands.html Outdated Show resolved Hide resolved
docs/commands.html Outdated Show resolved Hide resolved
docs/commands.html Show resolved Hide resolved
sovdeeth and others added 3 commits July 15, 2022 15:09
@sovdeeth sovdeeth requested a review from APickledWalrus July 16, 2022 03:11
Copy link
Member

@APickledWalrus APickledWalrus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fantastic job, this is awesome!

I won't lie, I learned a thing or two!

@AyhamAl-Ali
Copy link
Member

Indeed, great work on this 👏
This will wait a little bit until the new docs is merged, I will make sure to get this merged ASAP once the website is ready for tutorials (very soon)

Added example of how to use optional arguments like distinct flags (think command line argument flags)
@sovdeeth
Copy link
Member Author

Closing in favor of new PR on skript-docs repo: SkriptLang/skript-docs#8

@sovdeeth sovdeeth closed this Jan 23, 2023
@sovdeeth sovdeeth deleted the docs-command-tutorial branch October 13, 2024 18:53
@sovdeeth sovdeeth restored the docs-command-tutorial branch October 13, 2024 18:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Related to Skript's official documentation. enhancement Feature request, an issue about something that could be improved, or a PR improving something.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants