README

Hello fellow doc writer.

• The current page you're on, is the front page on the GitHub repo in the wiki branch, and is aimed at people who want to contribute to the documentation. Private notes for documentation contributors go here.
• The Home page is the front page on the GitHub wiki, which is aimed at devs or users who want to find out more about bqt.

goal of the docs

When writing the docs, try to always keep the following in mind:

• anyone can read how bqt works, and why
• anyone can follow instructions on how to use it
• the docs should never assume anyone knows anything, and explain things from scratch.
• docs should be as short as possible, look up "tight writing".
• docs are mostly aimed at devs who want to start using bqt for their tools.

doc write notes

• tips for bqt doc writers
• how to contribute to bqt documentation