Shirotohu update codestyle

[ShiroTohu]

What type of PR is this? (check all applicable)

• Refactor
• Feature
• Bug Fix
• Optimization
• Breaking Change
• Documentation Update

Description

I have just updated the code style to account for documentation styles. This will help me write the documentation and keep it consistent as well. It's a good reference.

Note

I the code style I wrote a little bit of a reference as to the styling of the parameter, attribute and method documentation. I think this could use some work, but since I am the only contributor, for the time being it should be alright.

Added changes

• Added parameter, attribute and method markdown documentation styles
• Added code block shorthand as standard
• Added Nextra callout documentation as well for reference
• Updated table of contents

Note

I also want to point out that I understand when writing the documentation, we kind of want to use the signature of whatever we are documenting with their types etc. This isn't present present in the code style markdown file. I might create an issue and put it in the backlog, while we focus on other things.

Related Tickets & Documents

• Related Issue Need to Update CODESTYLE.md for Documentation thread#91
• Closes Need to Update CODESTYLE.md for Documentation thread#91

QA Instructions, Screenshots, Recordings

Please replace this line with instructions on how to test your changes, a note
on the devices and browsers this has been tested on, as well as any relevant
images for UI changes.

Added/updated tests?

We encourage you to keep the code coverage percentage at 80% and above.

• Yes
• No, and this is why: code style update
• I need help with writing tests

Checklist

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
thread-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 24, 2024 3:23am

[caffeine-addictt]

LGTM!