mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-14 07:26:47 +00:00
ba92ba3254
* docs: Create new CODING_GUIDELINES doc Rids excess contribution instructions from other packages Adds AGENTS.md file for the AI overlords Rids unused templates Updates ADD_NEW_EXCHANGE.md with minor fixes * docs: Fix linter issues and minor adjustments based on Copilot feedback * docs: Update coding guidelines for API parameters and testing practices * docs: Remove redundant GoDoc references Adds copilot-instructions.md * docs: Update CODING_GUIDELINES with export recommendations and test commentary * docs: Fix formatting inconsistencies in ADD_NEW_EXCHANGE.md links * docs: Update struct naming conventions for request and response types * docs: Improve clarity and consistency in ADD_NEW_EXCHANGE.md and CODING_GUIDELINES.md * refactor: Simplify error handling in QueryOrder method
22 lines
584 B
Cheetah
22 lines
584 B
Cheetah
{{define "tools documentation" -}}
|
|
{{template "header" .}}
|
|
## Documentation Management Tool
|
|
|
|
### Current Features
|
|
|
|
+ Retrieves contribution activity via github API
|
|
+ Regenerates and updates documentation across the entire code base for each individual package
|
|
+ Allows for a documentation standard across this codebase
|
|
|
|
#### How to example
|
|
|
|
+ This will update the entire codebase when a change is made in the documentation templates
|
|
|
|
```sh
|
|
cd $GOPATH/src/github.com/thrasher-corp/gocryptotrader/tools/documentation/
|
|
go run gocryptotrader.go -r
|
|
```
|
|
|
|
{{template "donations" .}}
|
|
{{end}}
|