Skip to content

Update paths in adding new tutorials section #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update paths in adding new tutorials section #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ We are now using [docusaurus](https://docusaurus.io) to build our tutorials. You

## How to add a new tutorial page

1. Create the page in the `docs` folder (make sure it follows the same structure as the others).
2. Any images you need can be placed in the folder `docs/assets`.
3. Make sure you link to it in the `website/sidebars.json` properly.
1. Create the page in the `src/docs` folder (make sure it follows the same structure as the others).
2. Any images you need can be placed in the folder `src/docs/assets`.
3. Make sure you link to it in the `src/website/sidebars.json` properly.
4. To test the sidebars, you need to stop running it locally, then run it again.
5. If required, add a section in `website/pages/index.js` so everyone knows it exists!
5. If required, add a section in `src/website/pages/index.js` so everyone knows it exists!

## How to deploy

Expand Down