https://github.com/oguzhand95/keeping-docs-in-sync-with-code

Keeping documentation in sync with source code
https://github.com/oguzhand95/keeping-docs-in-sync-with-code

Last synced: 24 days ago
JSON representation

Keeping documentation in sync with source code

• Host: GitHub
• URL: https://github.com/oguzhand95/keeping-docs-in-sync-with-code
• Owner: oguzhand95
• Created: 2022-03-07T13:12:04.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-03-16T13:06:33.000Z (over 2 years ago)
• Last Synced: 2024-06-21T04:59:05.835Z (5 months ago)
• Language: Go
• Homepage: https://cerbos.dev
• Size: 68.4 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Keeping documentation in sync with source code

This repository is created for the workshop `Keeping documentation in sync with source code` and the

implementation made in the workshop will be based from the `main` branch.

## Requirements

- [Go >=1.17](https://go.dev/)

- make

## Usage

- `make build`: Tidies the go.mod, runs linters and builds the binary into `bin/main`.

- `make docs`: Runs the `docs` tool.