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

Added a navigation element nav to mkdocs.yml and edited docs/contributing.md #106

Merged
merged 1 commit into from
Jul 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
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
6 changes: 3 additions & 3 deletions docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# How to contribute to Arlon

## Code changes
TODO
Open a pull request (PR) on GitHub following the typical GitHub workflow [here](https://github.com/arlonproj/arlon/pulls).

## Bug reports
TODO
## Issues / Bug reports
We track issue in GitHub. Report an issue [here](https://github.com/arlonproj/arlon/issues/new).

## Documentation
Fork the Arlon repository on GitHub and make the desired changes.
Expand Down
6 changes: 6 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ theme:
icon: material/brightness-4
name: Switch to light mode

nav:
- Home: 'README.md'
- Design: 'design.md'
- How to contribute to Arlon: 'contributing.md'
- Help with MkDocs: 'help.md'

# name: gitbook
# name: 'rtd-dropdown'
#theme: ivory
Expand Down