> For the complete documentation index, see [llms.txt](https://code.janardhanpulivarthi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://code.janardhanpulivarthi.com/readme.md).

# About

Style guide

1. <https://developers.google.com/style>
2. <https://www.digitalocean.com/community/tutorials/digitalocean-s-technical-writing-guidelines#style>
3. <https://www.digitalocean.com/community/tutorials/technical-recommendations-and-best-practices-for-digitalocean-s-tutorials>
4. <https://developer.mozilla.org/en-US/docs/Glossary/Semantics#semantics_in_html>
5. <https://developers.google.com/season-of-docs/docs/project-metrics#state_your_problem>
6. <https://about.gitlab.com/handbook/marketing/inbound-marketing/content/content-marketing/>

Article checklist

1. Title of the tutorial How To \<Accomplish a Task> with \<Software> on \<Distro>&#x20;
2. How is this proposed topic a good addition to the library? GitHub metrics, google trends, knowledge gaps&#x20;
3. Introduction
   * [ ] What is the tutorial about?
   * [ ] Why should the reader learn this topic?
   * [ ] What will the reader do or create in this tutorial?
   * [ ] What will the reader have accomplished when they're done? instead of "how to", use "you will configure", "you will build"
4. Prerequisites Programming languages needed, software installation needed, GitHub account

![](/files/-MXOOnXV5u_1mFJXGakZ)
