A Git workflow to create, publish and maintain documentation with your team. Minimal time to ship, beautiful out-of-the-box. Centralize technical knowledge, connect to your codebase and collaborate through change requests.
I'm sharing this with my team to take a look! We need better ways or organizing documentation and this seems like a cool solution! How does it integrate with my current codebase? Ie, are these docs living in a branch or folder in my repo? Or totally separate? And also does anything happen on PRs when someone merges in new code to check if the docs need updating?
@britt_joiner Good to hear :) When using the GitHub/GitLab integrations, the documentation can be stored either as a directory in the repository or as a branch.
When using PR on GitHub/GitLab, we currently don't check the code to see if the docs need updating (it's definitely something we want to explore in the future ;) ), but we provide preview links to access the visual documentation from the PR.
Replies
Trello Tip Generator and Newsletter
GitBook
Trello Tip Generator and Newsletter
No Code Hero
NVSTly: Social Investing
OLOID M-Tag