Contributing

What is strived for

• Content should be cumulative and ordered based on where and how it should be learned.

Information should be explained thoroughly and written in a way that is understandable for beginners while still being useful for advanced users, such as people creating Bolt libraries.
Content should be ordered from top to bottom so readers can naturally progress from one concept to the next.

• Content info should be a mix of skimable and complete.

Important information should be easy to skim using headings, highlights, images, markdown formatting, and clear structure. At the same time, explanations should remain detailed enough that readers can gain in-depth knowledge without missing important information.

• Content should include examples and tutorials for introducing new code.

When explaining code, use fenced code blocks with triple backticks (```) so examples are easy to read and copy.

• Content being explained/described should be told one-on-one.

Write as if you are directly talking to the reader. Avoid overly broad phrases like “everyone” or “them” whenever possible to give tutorials a more personal feel.

• Content should contain references to other sources for more information.

Credit any external sources used for images, information, or inspiration. This helps avoid copyright issues and gives readers additional places to learn more about the subject.

• Content should not be AI generated.

AI can produce inaccurate information, especially for highly technical projects with limited documentation. Contributors should verify all information, links, images, and examples before publishing.

How to contribute.

require some knowledge of github / git to use.

At the bottom of every page is a Edit this page, you can click the button to edit said page! It will bring you to the repository where you can make a new pull request and build off any page or create new pages. see wiki syntax for more information based on how to build a new page from scratch.