search

FabricMC / fabric-docs

[WIP] Official curated documentation for Fabric, a modding toolchain for Minecraft.
https://docs.fabricmc.net
Other
61 stars 83 forks source link

"Using the ide" Page [Part 1] #111

Closed JR1811 closed 2 months ago

JR1811 commented 3 months ago

Original page: https://fabric.moddedmc.wiki/getting-started/using-the-ide Discussion in the Discord: https://discord.com/channels/507304429255393322/1208846408552030238/1235450767226437692

Content

I modified the content slightly to adapt to the new UI, mentioned split sources and added a small recommendation for the decompilers. Besides that, everything else should be mostly the same.

There are no changes in the reference directory since this topic doesn't focus on the code but rather on the usage and toolsets of the IDE. There shouldn't be any code logic which needs to be explained further or maintained in the future. They are only examples.

Problems

The "Basic Problem solving" page is linked already, but it's not in the new docs yet. I'll add it to a later pull request asap, if this pull request gets accepted.

Also, VSCode displays the MD033/no-inline-html: Inline HTML [Element: iframe] warning on the iframe HTML element at the end of the new page. Is there a better way to implement videos like that?

netlify[bot] commented 3 months ago

Deploy Preview for nimble-elf-d9d491 ready!

Name Link
Latest commit e2e71bdf755c016d41a1ec9d5c9318d3d48cc94a
Latest deploy log https://app.netlify.com/sites/nimble-elf-d9d491/deploys/66984d7629d5da0008057ce8
Deploy Preview https://deploy-preview-111--nimble-elf-d9d491.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

IMB11 commented 3 months ago

It's best if you use the <video> tag linking to a video file rather than a YouTube embed.

IMB11 commented 3 months ago

Hm actually, I thought the video was created by you, but if it's just a Jetbrains video, it can probably just be put into a bullet point list in that section with some other IntellJ IDEA guides

JR1811 commented 3 months ago

done. Anything else? ^^

IMB11 commented 3 months ago

Also, make sure you fix the markdownlint issues! I believe the only issues left are the Title Case not being used throughout the page.

modmuss50 commented 2 months ago

I think this page is really good, I learnt some stuff too! However I dont think its suitable for the "Getting Started" section, most of this will likely overwhelm someone who is just getting started. I would suggest moving it to the "Misc" group alongside codecs.