Maintain streamlined primary documentation (like README files) that focuses only on currently supported functionality and recommended approaches. Move specialized details, legacy systems, or deprecated methods to secondary documentation sources like wikis or specialized guides.
Maintain streamlined primary documentation (like README files) that focuses only on currently supported functionality and recommended approaches. Move specialized details, legacy systems, or deprecated methods to secondary documentation sources like wikis or specialized guides.
Why this matters:
Example: Instead of:
## Installation
### Build from source
- Build with Go >= 1.12
```bash
GO111MODULE=on make
# Deprecated instructions...
```
Prefer:
## Installation
### Build from source
```bash
GO111MODULE=on make
For special build scenarios or legacy systems, please see our Advanced Build Guide. ```
Enter the URL of a public GitHub repository