|
||
---|---|---|
scaffolds | ||
scripts | ||
source | ||
themes/navy | ||
.eslintignore | ||
.eslintrc | ||
.gitignore | ||
Jenkinsfile | ||
LICENSE | ||
README.md | ||
_config.dev.yml | ||
_config.prod.yml | ||
package.json |
README.md
Status Technical Docs
This repo hosts the code for both docs.status.im on the master
branch (which builds and serves through gh-pages
), and dev-docs.status.im on the develop
branch.
There is an edit
button on each page, which will take you directly to the document you need to edit on the develop
branch. We can then allow a large group of people to push directly to develop
and show their changes on the staging site when asking for review, which should smooth out and speed up the process considerably for everyone. master
is obviously protected, and will only have changes merged in from develop
once accepted.
Adding a New Page
If you want to add a page, rather than just edit, you'll need to make sure it appears on the sidebar and is accessible to everyone.
- Add your page to
source/docs/<your_file_here>.md
- In
source/_data/sidebars.yml
add the appropriate text to the appropriate place. - In
themes/navy/languages/en.yml
edit the sidebars section to make sure that your new text insidebars.yml
is rendered correctly.
Testing locally
Make sure you have node.js installed first.
- Open Terminal and navigate to the project root directory,
- Run
npm install
, - Run
npm run build
, - Go to
public/
directory, - Start a simple HTTP server serving files, for example:
python -m SimpleHTTPServer 8000
, - Open http://localhost:8000 in a browser.