Skip to content

Commit c9419f6

Browse files
committed
[readme] Add documentation section
1 parent fa45732 commit c9419f6

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,20 @@ HackathonManager makes use of a few different third-party services & Ruby gems:
4141

4242
**[Deploy HackathonManager for your hackathon »](https://coderit.org/hackathon-manager/docs/deployment)**
4343

44+
## Documentation
45+
46+
Documentation is available at https://coderit.org/hackathon-manager/
47+
48+
Docs are maintained as markdown files in the `docs/` folder, with the website configuration & tooling stored in `website/`.
49+
50+
Doc & website changes are auto-built and deployed via [Travis CI](https://travis-ci.org/codeRIT/hackathon-manager) once merged into master.
51+
4452
## Contributing
4553

4654
GitHub issues and pull requests welcome!
4755

56+
All documentation is easily editable using the GitHub UI. Click the "Edit" button at the top of any documentation page to get started.
57+
4858
If there's a new feature you're looking to implement, **please** file an issue to open discussion on the feature before starting work or opening a pull request.
4959

5060
## Development

0 commit comments

Comments
 (0)