search

ScratchAddons / website-v2

The website for Scratch Addons. (version 2)
https://scratchaddons.com
GNU General Public License v3.0
51 stars 39 forks source link

Add some new pages to addon docs #459

Closed Hexagonl closed 3 months ago

Hexagonl commented 5 months ago

I made a draft PR for now because I'd like for @Hans5958 to double check what I've made so far and ensure I'm on the right path. I'll continue making more pages and put the commits for those in this draft PR, to reduce cluttering the repository's PR history.

I'll also propose some guideline additions to the addon docs wiki in a separate issue/PR, which will be based off of stuff I've encountered while making the 60fps addon doc.

Current added addon docs

Hans5958 commented 5 months ago

Thank you! I guess I have few suggestions.

  1. Instead of "Issue #6860", I prefer "#6860". For that kind of usage I would prefer this instead.

    • The addon might be marked as dangerous to curb projects that require this addon on the Scratch website (#6860).

    Although I think "issue #6860" (with a little I) should be used just so the general users know that it refers to an issue, but I'm not sure if this is really needed.

  2. I think in TurboWarp, it is mentioned as "TurboWarp Addons", with a capital Addons.

  3. I would want to see the usage of the footnotes, especially the Trivia which I think you should cite. It works similary like GitHub. For example, like this[^some-cite-name] and this.[^1]

    [^1]: It doesn't have to be a number, but you can. [^some-cite-name]: Hello! This should still appear first even though it is written last on Markdown.

    For example, like this[^some-cite-name] and this.[^1]

[^1]: It doesn't have to be a number, but you can.
[^some-cite-name]: Hello! This should still appear first even though it is written last on Markdown.

  4. I just made changes so title: Higher project framerate mode is not needed on the front matter. You can remove it.

  5. I prefer do "The addon is now enabled" (with "The") instead of "Addon is now enabled" (similar to other such Option) but I guess this works.

WorldLanguages commented 5 months ago

Nice work!

WorldLanguages commented 3 months ago

@Hans5958 Please review again if you have some time.

I don't think we should be strict here, as long as there's not any false statements being added to the docs, any page is better than no page

WorldLanguages commented 3 months ago

Before merging see: https://github.com/ScratchAddons/website-v2/pull/459#discussion_r1703332505

Hexagonl commented 3 months ago

I fixed my earlier mistake of the cloud variables in the 60fps addon, made the requested changes, and also added an additional reference in the 60fps addon. I also marked as ready to review