Skip to content

Commit 6bc2fd8

Browse files
authored
Merge pull request #381 from ynput/380-update-readme
update Readme
2 parents 4815851 + 16c0a0f commit 6bc2fd8

1 file changed

Lines changed: 15 additions & 9 deletions

File tree

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
## AYON pipeline official documentation
1+
# AYON Developer Portal Official Documentation
22

3-
:exclamation: While we're transitioning from OpenPype, there are a lot of details the are factually incorrect. We're working on resolving all of them. :exclamation:
3+
AYON Developer Portal is where developers can find documentaiton about AYON development, backend, frontend, launcher desktop app or addons.
44

5-
:books: View the live [documentation](https://ayon.ynput.io).
5+
:books: View the live [AYON Developer Portal](https://docs.ayon.dev).
66

7-
:family: Check out our community discussions [forum](https://community.ynput.io).
7+
:open_book: Need to learn about using AYON as an artist or admin? Visit the [AYON Help Center](https://help.ayon.app/en/help).
88

9-
:phone: Want to know even more about AYON? Get in [contact](https://community.ynput.io/contact).
9+
:family: Join our community discussions in the [Ynput Forums](https://community.ynput.io).
1010

11-
:raising_hand: Need some support or want something custom? Take a look at our [services](https://ynput.io/services/).
11+
:phone: Want to know even more about AYON? Get in [Contact](https://ynput.io/contact).
12+
13+
:raising_hand: Need support or want something custom? Explore our [Services](https://ynput.io/services/).
14+
15+
:bulb: Have ideas or requests? Share them on our [Feedback Portal](https://feedback.ayon.app/).
1216

1317
## Contribute
1418

@@ -17,13 +21,15 @@ If you spot something incorrect or just think a page could do with some improvem
1721
1. Make the changes to the relevant markdown file.
1822
2. Make a PR documenting the changes.
1923

20-
## Build
24+
## Running documentation live
2125

2226
- Install Node.js https://nodejs.org/en/download
2327
- `npm install -g yarn`
24-
- `yarn add docusaurus --dev`
2528
- `cd {ayon-doc-repo}/website`
26-
- `yarn start`
29+
- `yarn install`
30+
- `yarn run start`
31+
32+
For additional info, refer to the [Official Docusaurus Documentation](https://docusaurus.io/docs/installation#running-the-development-server).
2733

2834
## Addons
2935

0 commit comments

Comments
 (0)