Back to all reviewers

Focus documentation content

fatedier/frp
Based on 2 comments
Markdown

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.

Documentation Markdown

Reviewer Prompt

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:

  • Reduces maintenance burden
  • Keeps main documentation relevant and concise
  • Follows official platform recommendations
  • Improves user experience for the majority of users

Example: Instead of:

## Installation

### Build from source

- Build with Go >= 1.12
  ```bash
  GO111MODULE=on make
  • Build with Go < 1.12 (Not maintained)
    # Deprecated instructions...
    

    ```

Prefer:

## Installation

### Build from source

```bash
GO111MODULE=on make

For special build scenarios or legacy systems, please see our Advanced Build Guide. ```

2
Comments Analyzed
Markdown
Primary Language
Documentation
Category

Source Discussions