google / google/dotguides

Consider two sections in the README, one for Developers and one for Authors

Open
#8 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
TypeScript
Stars
72
Forks
2
PR merge metrics
No merged PRs in 30d

Description

I think it will help to have two very clear sections in the readme.

The first section would be "dotguides for developers" and tell them why they want to install it and how to enable it for their project, and what exactly does "enable it for your project" means. Sell the developer on why they want to turn on dotguides for their project. Explain how it integrates into their coding agent, and which coding agents dotguides supports.

The second section would be "dotguides for package or library authors", and tell them why they want to author dotguides for their developers. Then, show them how to get started authoring. Link to best practices, etc, etc

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.