Skip to content
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

Update docs build instruction #235

Closed
wants to merge 2 commits into from
Closed

Update docs build instruction #235

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef3dce9
update docs build instruction
MustafaJafar Sep 7, 2024
b9da951
Merge branch 'main' into enhancement/update_doc_build_instruction
MustafaJafar Oct 3, 2024
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
22 changes: 17 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,24 @@ If you spot something incorrect or just think a page could do with some improvem
2. Make a PR documenting the changes.

## Build
### Configure Environment
To get started, ensure you have the following:

- Install Node.js https://nodejs.org/en/download
- `npm install -g yarn`
- `yarn add docusaurus --dev`
- `cd {ayon-doc-repo}/website`
- `yarn start`
- Download and install Node.js from [nodejs.org](https://nodejs.org/en/download).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Download and install Node.js from [nodejs.org](https://nodejs.org/en/download).
- Download and install [Node.js](https://nodejs.org/en/download).

Would this suffice too?

- Open your terminal and run `npm install -g yarn`.

### AYON Documentation Configuration
For the initial setup after cloning the AYON documentation repository, execute these steps:

- In your terminal, navigate to the website directory: `cd {ayon-doc-repo}/website`.
- Add Docusaurus as a development dependency: `yarn add docusaurus --dev`.

### Run Docs Live
Before launching the live documentation, it's a good practice to clear the cache:

- Delete the cache directory found at `{ayon-doc-repo}/website/.docusaurus`.
- In your terminal, navigate to the website directory: `cd {ayon-doc-repo}/website`.
- Start the live server with `yarn start`.

## Addons

Expand Down