Skip to content

[Rewrite] Wiki base structure #52

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

Merged
merged 20 commits into from
Sep 15, 2023

Conversation

anonymous123-code
Copy link
Contributor

@anonymous123-code anonymous123-code commented Sep 3, 2023

  • Adds Create Item tutorial
  • Adds Create Block tutorial
  • Adds Food Item tutorial
  • Adds empty stubs with names for other articles in the MVP
  • Allows for articles and categories to be ordered using the index metadata
  • Add automatic links and ids to headings (Was not able to fully test because of font awesome)
  • Add automatic table of contents to the right
  • Align content to the middle, with a max-width
  • Some minor fixes in present articles (capitalization etc)
  • Fixes numbers in codeblocks being formatted wrong
  • removes an unnecessary category parameter in the Article metadata

@anonymous123-code
Copy link
Contributor Author

Here is a screenshot of the article list with this PR:
grafik

Copy link
Member

@supersaiyansubtlety supersaiyansubtlety left a comment

Choose a reason for hiding this comment

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

Looks good.
Just a few typos, formatting, and wording that could be clearer.

Copy link
Member

@supersaiyansubtlety supersaiyansubtlety left a comment

Choose a reason for hiding this comment

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

Just a couple more things I missed in the first pass, and a question.

Now that you tried using the Javadocs *cough, cough*, here is an alternate explanation:

1. We instantiate a new builder. Using this, we can configure the `FoodComponent` before finally turning it into a proper `FoodComponent`. Note that all the following values are by default 0, false or empty.
2. We set the hunger to 2, which corresponds to one of the total 10 drumsticks in Minecraft.
Copy link
Member

Choose a reason for hiding this comment

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

Is there a reason to use the actual numbers here (after 1)?
It seems like it's just slightly more work to update should a new version ever add a new food component setting.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Mainly because this way the markdown is also quite readable, so mostly personal preference. I didn't apply the changes directly because it broke somehow and started overriding stuff.

Copy link
Member

@ix0rai ix0rai left a comment

Choose a reason for hiding this comment

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

some feedback for the block article, I decided to leave it at that or I'd rewrite half the item tutorial. one overall comment:
we need a convention on capitalisation. I suggest "Adding a block, using block states, working with entities" (lowercase everything like QM) over the current "Adding a Block, using BlockStates, working with Entities", since there's no clear convention here.

Co-authored-by: Will <[email protected]>
@OroArmor
Copy link
Member

OroArmor commented Sep 9, 2023

Let me know if this is ready to merge and ill put a 5 day FCP on it

@anonymous123-code
Copy link
Contributor Author

I do not plan on adding anthing new to this PR (The scope is already way to big), and all review seem to be resolved, so I'd be fine with merging. But I'm unsure about the accessebility of the page layout (I did some minor CSS hackery), it'd be great if someone who knows this stuff a bit could take a look.

I also plan on PRs to:

@OroArmor
Copy link
Member

Sounds good. Merging this in 5 days.

@sleepy-evelyn
Copy link

I'm not sure if these issues are from this PR specifically but I think the automatic contents one is at least. I don't have enough knowledge to fix these but I thought id share the issues anyway.

Automatic contents

Reduces space on the screen and is able to squash the main content of the wiki page down so it's no longer readable

Screenshot 2023-09-10 at 14 16 05

Code block styling

Font for the code blocks is slightly larger than the main text which looks very weird. This might have been fixed in the re-write PR

Screenshot 2023-09-10 at 14 19 18

@sylv256
Copy link

sylv256 commented Sep 10, 2023

Should I wait until this is merged to PR the QMJ wiki page?

@sylv256 sylv256 mentioned this pull request Sep 10, 2023
6 tasks
@ix0rai ix0rai added enhancement New feature or request content Relates to the content of the wiki labels Sep 14, 2023
@OroArmor OroArmor merged commit 9c98b67 into QuiltMC:rewrite Sep 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Relates to the content of the wiki enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants