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.

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

Docs Contribution Guide on README.md #438

Merged
merged 7 commits into from
Oct 20, 2021
Merged
Changes from 1 commit
Commits
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
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,29 @@ Clone/download source code from the GitHub. Make sure you have _node_ and _npm_
1. snapcraft login
2. snapcraft upload Gaucho_0.6.0_amd64.snap --release=stable

#### For Contributing to Docs:
adnanqazii marked this conversation as resolved.
Show resolved Hide resolved
> Production Docs at https://angrykoala.github.io/gaucho/
adnanqazii marked this conversation as resolved.
Show resolved Hide resolved
> Docs built using https://docusaurus.io/.
##### Instructions:
* The docs branch is https://github.com/angrykoala/gaucho/tree/docs.
* Commands for Development:
adnanqazii marked this conversation as resolved.
Show resolved Hide resolved
* npm install
adnanqazii marked this conversation as resolved.
Show resolved Hide resolved
* npm docusaurus,
* npm start
* npm run build
* npm run swizzle
* npm run deploy
* npm run clear
* npm run serve
* npm run write-translations
* npm run write-heading-ids
* Folders:
* /docs: Docs pages corresponding to items in menu(introduction,getting started etc) on Docs page.
* /src/pages: Pages for each item in page menu.

**Modifications to Docs should be done against /docs branch.**
* Instructions to deploy (only for collaborators):
* npm serve will upload source code to https://github.com/angrykoala/gaucho/tree/gh-pages)
adnanqazii marked this conversation as resolved.
Show resolved Hide resolved

### Troubleshooting

Expand Down