Skip to content

Commit

Permalink
refactor(docs): update documentation (#27)
Browse files Browse the repository at this point in the history
  • Loading branch information
csantiago132 authored Oct 10, 2024
1 parent 9910997 commit c6e7247
Show file tree
Hide file tree
Showing 7 changed files with 41 additions and 33 deletions.
27 changes: 3 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
# Kurocado Studio Style Guide

This repository contains the style guide for our project, specifically tailored for TypeScript. We
have used the [Vercel Style Guide](https://github.com/vercel/style-guide) as a base for our
TypeScript configurations, and aspire to maintain the same high standards in our code quality. We
extend our thanks to [Vercel](https://github.com/vercel/style-guide) for open-sourcing their
styleguide
A comprehensive style guide based on Vercel's style guide, enabling developers to set up
repositories quickly with consistent code quality and best practices.

### Installation

Expand All @@ -16,24 +13,6 @@ npm install --save-dev @kurocado-studio/style-guide
yarn add --dev @kurocado-studio/style-guide
```

## Dependencies

Below are the CLI dependencies needed to run the styleguide configurations

```json
{
"devDependencies": {
"@commitlint/cli": "19.0.3",
"@commitlint/config-conventional": "19.0.3",
"eslint": "8.57.0",
"husky": "9.0.11",
"jest": "^29.7.0",
"prettier": "3.3.3",
"semantic-release": "23.0.2",
"typescript": "5.3.3"
}
}
```
## Dependencies & Setup

[Read more at https://kurocado-studio.github.io/styleguide](https://kurocado-studio.github.io/styleguide/starter-topic.html)
| [NPM Package](https://www.npmjs.com/package/@kurocado-studio/style-guide)
3 changes: 2 additions & 1 deletion Writerside/dcs.tree
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@

<instance-profile id="dcs"
name="Style Guide"
start-page="starter-topic.md">
start-page="PRD.md">

<toc-element topic="PRD.md"/>
<toc-element topic="starter-topic.md"/>
<toc-element topic="Workflows.md">
<toc-element topic="Writerside.md"/>
Expand Down
2 changes: 2 additions & 0 deletions Writerside/topics/Code-Quality.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## Overview

Ensures code consistency and quality through automated linting and formatting checks.

The following sequence diagram illustrates the interactions and steps involved in the **Code
Quality** workflow, triggered by a push to the `main` branch or a pull request.

Expand Down
26 changes: 26 additions & 0 deletions Writerside/topics/PRD.md
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.
3 changes: 3 additions & 0 deletions Writerside/topics/Release.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

## Overview

Automates the release process, including versioning, changelog generation, and pull request
creation.

The following sequence diagram illustrates the interactions and steps involved in the Release
workflow, triggered by a push to the `main` branch.

Expand Down
2 changes: 2 additions & 0 deletions Writerside/topics/Writerside.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## Overview

Builds and deploys project documentation using Docker-based builders.

The following sequence diagram illustrates the interactions and steps involved in the Writerside
Documentation workflow, triggered by a push to the main branch or a workflow call.

Expand Down
11 changes: 3 additions & 8 deletions Writerside/topics/starter-topic.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
# Style Guide
# Setup

[NPM Package](https://www.npmjs.com/package/@kurocado-studio/style-guide) |
[GitHub Repository](https://github.com/Kurocado-Studio/styleguide)

This repository contains the style guide for our project, specifically tailored for TypeScript. We
This repository contains the style guide for our projects, specifically tailored for TypeScript. We
have used the [Vercel Style Guide](https://github.com/vercel/style-guide) as a base for our
TypeScript configurations, and aspire to maintain the same high standards in our code quality. We
extend our thanks to [Vercel](https://github.com/vercel/style-guide) for open-sourcing their
styleguide
TypeScript configurations, and aspire to maintain the same high standards in our code quality.

## Overview

Expand Down

0 comments on commit c6e7247

Please sign in to comment.