https://github.com/cuboulder/documentation
https://github.com/cuboulder/documentation
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cuboulder/documentation
- Owner: CuBoulder
- Created: 2021-08-04T15:34:20.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-11-22T17:28:14.000Z (over 1 year ago)
- Last Synced: 2025-01-22T15:13:05.723Z (over 1 year ago)
- Size: 128 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Documentation
## What goes here?
This is a repository for our Team's general documentation. Many things belong here:
- On boarding information
- Tools we use and how to set them up
- Common tasks that need to be executed
- General information for and links to our main projects
- Other things we all need to know or are likely to look up.
## What does not go here?
Documentation for particular projects, which should live in each project's repository.
## Adding to documentation
All documentation goes in the `docs` directory. You can follow this kind of structure:
```text
docs
|___subject1
| | relevant_doc
| | another_relevant_doc
| |
| |___subfolder
| | subfolder_doc
|
|
|___subject2
| | relevant_doc
| | another_relevant_doc
```