The DevTools community welcomes any contributions or bug-fixes. Before submitting a pull request, please open a new issue to let us know what you are working on. This will allow others to provide feedback as well as coordinate contribution efforts.
Submit all requests against the master branch unless instructed to do otherwise.
A few guidelines to follow when writing are:
- Avoid the use of "we" (and alike.)
- Active voice is preferred over passive voice.
- Try to have text content self-standing. Images should be used as an enhancement of the content instead of a requirement for understanding.
- Be as concise as possible.
- docs
- Contains all the working files. Each document page has its own HTML file. If a page has files specific to its content, then a resources folder exists for that page.
- index.html
- Contains the project overview page.
- images
- Contains images for index.html and minor images used within the documents.
- docs/redirects.json
- Contains redirects from one location to another.
When making a big change to the documentation, please write your draft in a Google Doc and make it open for public commenting. It is easier to provide feedback and to find errors in a doc rather than a web page. Once someone has given a LGTM (looks good to me) response then you are safe to code up the change and submit a pull request.
Small changes can go in as a pull request directly.
- contributing-images.md details our policy for images and callout style.
Spellchecker, built into just about every document editor.
Hemingway will run an analysis on the given text and point out possible grammatical issues.
- Do not have any hard to read sentences.
- Have as few adverbs as possible.
- Use the simplest words.
For image compression the following tools are available
- ImageOptim on a Mac.
- PNGGauntlet on Windows
- Trimage on Linux distrobutions
- In the root of the project, start a server.
- It's easier if your server can also do a directory listing.
- Open http://localhost:8000/docs/_preview.html
- You will see the boilerplate along with a directory listing
- Click one of them.
- It should bring you to a url like http://localhost:8000/docs/_preview.html?settings.html
- you can navigate to this directly if you like
- it looks like this
- Things mostly work but is not exactly the same as viewing the production site.
- In production the site is rendered via "docserver". Markdown is parsed via the python-markdown library.