pitz-tech/monorepo
Template
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
main
monorepo/docs
History
mya fa2489844a
epoch
2024-07-06 20:34:19 -05:00
..
internal epoch 2024-07-06 20:34:19 -05:00
public epoch 2024-07-06 20:34:19 -05:00
README.md epoch 2024-07-06 20:34:19 -05:00

README.md

Documentation

Documentation has a few different scopes that everyone should be aware of. Internal documentation is documentation that focuses on things relevant to employees of the company.

Internal

‼️ This documentation is private to the company.

Internal documentation doesn't need to be as fancy as it's public facing counter-part.

Decisions

Designs

Runbooks

Public

‼️ This documentation is public, and accessible to end-users.

Most projects implement public documentation using solutions like Jekyll, Hugo, and Astro.