Improve LoopDocs
How to Improve LoopDocs¶
Please submit suggestions for updates and improvements to this documentation. There are many pages of content and we welcome reviewers to help find typos and outdated info/links. If you notice a typo, poor word choice or some explanation that could be improved or clarified, there are a few options. The first two options use github, a website where open-source code and documentation is often shared. You can only use github if you have an account (it's free).
- You can issue a Pull Request (best option if it is a simple typo or wording update)
- You can open an Issue (best option if a major rewrite is needed or you think a conversation would help), or
- You can post on Facebook or Zulipchat
Pull Requests and Issues¶
If you decide to do a GitHub Pull Request (PR) or create an Issue, first look to see if someone has already opened a PR or Issue on the topic so you don't create a duplicate.
- If a PR or Issue on the topic is open, feel free to add your comments (don't be shy), but please don't create a duplicate
- If a PR doesn't exist, watch this LoopDocs Pull Request video on how to create one (it's easy, video is less than 5 minutes)
- If your Issue is new, please add it by clicking on the
New Issuebutton- Give the Issue a descriptive title
- Indicate which page or pages need updating , along with a brief description of the problem(s)
Facebook or Zulipchat¶
Helpful tips for providing LoopDocs feedback through Facebook and/or Zulipchat:
- In
LoopandLearnFacebook Group - make sure your post is clear that you have a comment about LoopDocs in particular. - In Loop Zulipchat, please use the documentation channel, Loopdocs Issue topic.