Here are a few tips on how to write your content; however, the library maintainers are here to help you with that, so you don’t have to worry too much about it. It will get polished during the review phase before publishing:
The “Official” language of the library is US English.
Try to limit yourself in terms of formatting options. Stick to basics like paragraphs, headings, lists, code/quote blocks, tables, and images. We aim to make the content friendly to other platforms that don’t support advanced features like toggles or column layouts.
Avoid colored texts, texts with colored backgrounds, and formatting using lots of spaces or blank lines. Prefer semantic formatting.
Ensure that 3rd party content you embed into your page, like citations, is properly attributed by mentioning the author's name, full title, publisher, and date. If any of those is unclear, e.g., when there isn’t a single author, leave that out. On top of attribution, check copyright protections for embedded media like videos or images.
We recommend using APA-style references. There are examples of all common use cases in the APA style reference guide, especially the section “Online Media,” and the Webpage on a Website References examples. Here’s a sample citation from an online article:
“One of the tragedies in software development, and all product development for that matter, is that much of what we build doesn’t succeed.”
Jeff Patton & Associates. (May 10, 2017). Dual Track Development is not Duel Track. https://jpattonassociates.com/dual-track-development/
If you believe breaking your content into multiple pages would better suit your use case, please consult the maintainer.
When you’re done writing, please ping the maintainer or tag them in a comment. They’ll then proceed with the review and publishing phases.