Skip to content

Conversation

aquagoose
Copy link
Contributor

Summary of the PR

This PR adds OpenGL tutorials to the Silk.NET website, using the code provided by the existing samples.

Related issues, Discord discussions, or proposals

https://discord.com/channels/521092042781229087/587346162802229298/1037331531619905596

Further Comments

I'd like to add a couple more tutorials before merging the PR, just so that there is enough to get started with.

@aquagoose aquagoose requested a review from a team as a code owner November 2, 2022 12:14
@ThomasMiz
Copy link
Contributor

Thanks for the contribution! I like what you've written, but I will be leaving a few comments 👀

@ThomasMiz
Copy link
Contributor

Nicely done!

  • I like the friendly writing
  • You explain what each line of code does instead of just it, letting readers better understand
  • Nice to mention the "next tutorial", so readers know what to do next
  • Nice to link the discord server!

@aquagoose
Copy link
Contributor Author

I've added most of the suggested changes - just left a couple that I will wait on your response for before I add them.

I was originally going to change the > [!Note] stuff, but seems like you're planning to add that? It would be very handy (my tutorials will make heavy use of them), as will warnings too.

@ThomasMiz
Copy link
Contributor

Looking great!

@Perksey
Copy link
Member

Perksey commented Nov 4, 2022

I was originally going to change the > [!Note] stuff, but seems like you're planning to add that? It would be very handy (my tutorials will make heavy use of them), as will warnings too.

I mean, I did intend on adding it at some point. Don't know when I'll get a chance, but essentially it'll just end up being similar to the FancyImage shortcode (implemented in FancyImageShortCode.cs) to output something like

<div class="alert alert-info">
Content...
</div>

Adding a shortcode is very easy, tbh the Silk.NET.Statiq project is super easy to navigate so if you wanted to give it a go by all means do! If not, just leave it as is for now and hopefully someone gets round to it.

@Perksey
Copy link
Member

Perksey commented Nov 4, 2022

Giving @ThomasMiz authority over this one given Thomas is probably the best maintainer for documentation/OpenGL user experience (and given I don't have anything to add :))

@Perksey Perksey assigned Perksey and ThomasMiz and unassigned Perksey Nov 4, 2022
@aquagoose
Copy link
Contributor Author

Adding a shortcode is very easy, tbh the Silk.NET.Statiq project is super easy to navigate so if you wanted to give it a go by all means do! If not, just leave it as is for now and hopefully someone gets round to it.

I'll take a look at adding it, it will be very handy to have for the tutorials.

aquagoose and others added 15 commits December 28, 2022 22:57
i thought i commited all of these but GH didnt show me all of them

Co-authored-by: ThomasMiz <[email protected]>
@aquagoose
Copy link
Contributor Author

I appreciate the comments & suggestions! And yeah, it was a lot more effort than I was expecting too. Many tutorials just seem to be the "here copy this code and it works and you don't need to know why" sorta thing and I absolutely hate that, so I made sure to explain exactly what was going on.

I've committed most of the suggestions, I've left a couple open since I won't commit that exact suggestion but I'll write close to it, and a couple have been left open as I don't agree with a couple of changes, but if you wish I am happy to change them too.

I'll make the finishing touches tomorrow, and then if all is good it should be complete!

@aquagoose
Copy link
Contributor Author

Seems like everything has now been resolved, so if all is good then this this PR should be ready.

I'll get to the next set of tutorials soon and submit a new PR for those. Trying to write at least two at a time, depending on their complexity, and more if possible.

@ThomasMiz ThomasMiz enabled auto-merge (squash) January 6, 2023 02:29
@ThomasMiz ThomasMiz merged commit 23ae5b1 into dotnet:main Jan 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants