forked from thrasher-corp/gocryptotrader
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation Update (thrasher-corp#318)
* Initial update * update * Fix linter issues * Add new documentation template and fix
- Loading branch information
Showing
10 changed files
with
482 additions
and
352 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| # GoCryptoTrader package Documentation | ||
|
|
||
| <img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/page-logo.png?raw=true" width="350px" height="350px" hspace="70"> | ||
|
|
||
|
|
||
| [](https://travis-ci.org/thrasher-/gocryptotrader) | ||
| [](https://github.com/thrasher-/gocryptotrader/blob/master/LICENSE) | ||
| [](https://godoc.org/github.com/thrasher-/gocryptotrader/cmd/documentation) | ||
| [](http://codecov.io/github/thrasher-/gocryptotrader?branch=master) | ||
| [](https://goreportcard.com/report/github.com/thrasher-/gocryptotrader) | ||
|
|
||
|
|
||
| This documentation package is part of the GoCryptoTrader codebase. | ||
|
|
||
| ## This is still in active development | ||
|
|
||
| You can track ideas, planned features and what's in progresss on this Trello board: [https://trello.com/b/ZAhMhpOy/gocryptotrader](https://trello.com/b/ZAhMhpOy/gocryptotrader). | ||
|
|
||
| Join our slack to discuss all things related to GoCryptoTrader! [GoCryptoTrader Slack](https://join.slack.com/t/gocryptotrader/shared_invite/enQtNTQ5NDAxMjA2Mjc5LTQyYjIxNGVhMWU5MDZlOGYzMmE0NTJmM2MzYWY5NGMzMmM4MzUwNTBjZTEzNjIwODM5NDcxODQwZDljMGQyNGY) | ||
|
|
||
| ## Current Features for documentation | ||
|
|
||
| #### This tool allows for the generation of new documentation through templating | ||
|
|
||
| From the `gocryptotrader/cmd/documentation/` folder, using the go command: **go run documentation.go** this will auto-generate and regenerate documentation across the **GoCryptoTrader** code base. | ||
| >Using the -v command will, ie **go run documentation.go -v** put the tool into verbose mode allowing you to see what is happening with a little more depth. | ||
| Be aware, this tool will: | ||
| - Works off a configuration JSON file located at ``gocryptotrader/cmd/documentation/`` for future use with multiple repositories. | ||
| - Automatically find the directory and file tree for the GoCryptoTrader source code and alert you of undocumented file systems which **need** to be updated. | ||
| - Automatically find the template folder tree. | ||
| - Fetch an updated contributor list and rank on pull request commit amount | ||
| - Sets up core folder docs for the root directory tree including **LICENSE** and **CONTRIBUTORS** | ||
|
|
||
| ### config.json example | ||
|
|
||
| ```json | ||
| { | ||
| "githubRepo": "https://api.github.com/repos/thrasher-/gocryptotrader", This is your current repo | ||
| "exclusionList": { This allows for excluded directories and files | ||
| "Files": null, | ||
| "Directories": [ | ||
| "_templates", | ||
| ".git", | ||
| "web" | ||
| ] | ||
| }, | ||
| "rootReadmeActive": true, allows a root directory README.md | ||
| "licenseFileActive": true, allows for a license file to be generated | ||
| "contributorFileActive": true, fetches a new contributor list | ||
| "referencePathToRepo": "../../" | ||
| } | ||
| ``` | ||
| ### Template example | ||
| >place a new template **example_file.tmpl** located in the current gocryptotrader/cmd/documentation/ folder; when the documentation tool finishes it will give you the define template associated name e.g. ``Template not found for path ../../cmd/documentation create new template with \{\{define "cmd documentation" -\}\} TEMPLATE HERE \{\{end}}`` so you can replace the below example with ``\{\{define "cmd documentation" -}}`` | ||
| ``` | ||
| \{\{\define "example_definition_created_by_documentation_tool" -}} | ||
| \{\{\template "header" .}} | ||
| ## Current Features for documentation | ||
| #### A concise blurb about the package or tool system | ||
| + Coding examples | ||
| import "github.com/thrasher-/gocryptotrader/something" | ||
| testString := "aAaAa" | ||
| upper := strings.ToUpper(testString) | ||
| // upper == "AAAAA" | ||
| {\{\template "contributions"}} | ||
| {\{\template "donations"}} | ||
| {\{\end}} | ||
| ``` | ||
|
|
||
| ### ALL NEW UPDATES AND FILE SYSTEM ADDITIONS NEED A DOCUMENTATION UPDATE USING THIS TOOL OR PR MERGE REQUEST MAY BE POSTPONED. | ||
|
|
||
|
|
||
| ### Please click GoDocs chevron above to view current GoDoc information for this package | ||
|
|
||
| ## Contribution | ||
|
|
||
| Please feel free to submit any pull requests or suggest any desired features to be added. | ||
|
|
||
| When submitting a PR, please abide by our coding guidelines: | ||
|
|
||
| + Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). | ||
| + Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. | ||
| + Code must adhere to our [coding style](https://github.com/thrasher-/gocryptotrader/blob/master/doc/coding_style.md). | ||
| + Pull requests need to be based on and opened against the `master` branch. | ||
|
|
||
| ## Donations | ||
|
|
||
| <img src="https://github.com/thrasher-/gocryptotrader/blob/master/web/src/assets/donate.png?raw=true" hspace="70"> | ||
|
|
||
| If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to: | ||
|
|
||
| ***1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB*** | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| {{define "cmd documentation" -}} | ||
| {{template "header" .}} | ||
| ## Current Features for {{.Name}} | ||
|
|
||
| #### This tool allows for the generation of new documentation through templating | ||
|
|
||
| From the `gocryptotrader/cmd/documentation/` folder, using the go command: **go run documentation.go** this will auto-generate and regenerate documentation across the **GoCryptoTrader** code base. | ||
| >Using the -v command will, ie **go run documentation.go -v** put the tool into verbose mode allowing you to see what is happening with a little more depth. | ||
|
|
||
| Be aware, this tool will: | ||
| - Works off a configuration JSON file located at ``gocryptotrader/cmd/documentation/`` for future use with multiple repositories. | ||
| - Automatically find the directory and file tree for the GoCryptoTrader source code and alert you of undocumented file systems which **need** to be updated. | ||
| - Automatically find the template folder tree. | ||
| - Fetch an updated contributor list and rank on pull request commit amount | ||
| - Sets up core folder docs for the root directory tree including **LICENSE** and **CONTRIBUTORS** | ||
|
|
||
| ### config.json example | ||
|
|
||
| ```json | ||
| { | ||
| "githubRepo": "https://api.github.com/repos/thrasher-/gocryptotrader", This is your current repo | ||
| "exclusionList": { This allows for excluded directories and files | ||
| "Files": null, | ||
| "Directories": [ | ||
| "_templates", | ||
| ".git", | ||
| "web" | ||
| ] | ||
| }, | ||
| "rootReadmeActive": true, allows a root directory README.md | ||
| "licenseFileActive": true, allows for a license file to be generated | ||
| "contributorFileActive": true, fetches a new contributor list | ||
| "referencePathToRepo": "../../" | ||
| } | ||
| ``` | ||
| ### Template example | ||
| >place a new template **example_file.tmpl** located in the current gocryptotrader/cmd/documentation/ folder; when the documentation tool finishes it will give you the define template associated name e.g. ``Template not found for path ../../cmd/documentation create new template with \{\{define "cmd documentation" -\}\} TEMPLATE HERE \{\{end}}`` so you can replace the below example with ``\{\{define "cmd documentation" -}}`` | ||
|
|
||
| ``` | ||
| \{\{\define "example_definition_created_by_documentation_tool" -}} | ||
| \{\{\template "header" .}} | ||
| ## Current Features for {{.Name}} | ||
|
|
||
| #### A concise blurb about the package or tool system | ||
|
|
||
| + Coding examples | ||
| import "github.com/thrasher-/gocryptotrader/something" | ||
| testString := "aAaAa" | ||
| upper := strings.ToUpper(testString) | ||
| // upper == "AAAAA" | ||
|
|
||
| {\{\template "contributions"}} | ||
| {\{\template "donations"}} | ||
| {\{\end}} | ||
| ``` | ||
|
|
||
| ### ALL NEW UPDATES AND FILE SYSTEM ADDITIONS NEED A DOCUMENTATION UPDATE USING THIS TOOL OR PR MERGE REQUEST MAY BE POSTPONED. | ||
|
|
||
|
|
||
| ### Please click GoDocs chevron above to view current GoDoc information for this package | ||
| {{template "contributions"}} | ||
| {{template "donations"}} | ||
| {{end}} |
Oops, something went wrong.