-
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.
refactor(docs): update documentation (#27)
- Loading branch information
1 parent
9910997
commit c6e7247
Showing
7 changed files
with
41 additions
and
33 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
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,26 @@ | ||
# Styleguide PRD | ||
|
||
## Vision and Scope | ||
|
||
Provide a comprehensive style guide based on Vercel's, enabling developers to set up repositories | ||
quickly with high-quality standards. | ||
|
||
## Objectives | ||
|
||
- Accelerate repo setup for developers. | ||
- Ensure code quality and consistency across projects. | ||
- Showcase the studio's expertise to attract potential clients. | ||
|
||
## Requirements | ||
|
||
- Create a style guide repository with linting rules, formatting standards, and setup instructions. | ||
- Create reusable GitHub Actions workflows | ||
- Writerside | ||
- Code Quality | ||
- Release | ||
- Include code samples and examples for quick reference. | ||
|
||
## Risks and Mitigation | ||
|
||
- **Risk**: Developers might find the style guide too restrictive. | ||
- **Mitigation**: Make the style guide configurable to suit different project needs. |
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