Adding first how-to guide as a basic example

[jimbobbennett]

Created a first how-to guide for saving a snippet to show the basic structure.

Also added a contributing file with more details.

I've added the .vscode folder back to include settings for CSpell - the code spell checker. This sets things like enabling it for MDX files, and allows us to ingore certain words.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
documentation	✅ Ready (Inspect)	Visit Preview	Aug 7, 2024 8:15pm

[shivaypiece]

I think all of the assets should go into the assets directory and only the .mdx file should be there in the docs section.

[jimbobbennett]

I think all of the assets should go into the assets directory and only the .mdx file should be there in the docs section.

Not personally a fan of that - you end up with an assets folder full of files and it's hard to track what is there. Great for some global files (logos etc.), but not for images relevant to docs. I prefer it in the relevant folder so it's easy to find the images.

Obviously will follow the standard if required, but would push for the standard to be putting images in the same folder as the markdown file.

[shivaypiece]

Looks good!

[mason-at-pieces]

@jimbobbennett @shivay-at-pieces So, about the assets being in the docs directory.

I agree that global assets are great to have in the assets folder. I'm fine with having one-off assets in their own respective folders. The assets folder has become quite messy just because it was started as a centralized location for storage.

For media that are used in multiple places, let's put them in the global static folder. For media that is specific to a page, put it inside a media folder. Inside that media folder, please also make folders for images, videos, etc so that is remains organized and not just a folder full of different types of files.

[mason-at-pieces]

Please move all webp files into a media/images folder so we keep the directory clean.

Also please move the helloworld.py file into a folder called resources

[shivaypiece]

@mason-at-pieces you can have a look at the updated structure for the resources and media