hackforla / hackforla/tables

Create structure for Platform documentation in wiki

Open
#69 2 comments 0 reactions 1 assignee Claimed by @ExperimentsInHonesty View on GitHub
Complexity: Small feature: wiki role: dev lead role: product size: 0.25pt
Dominant language
JavaScript
Stars
2
Forks
0
PR merge metrics
No merged PRs in 30d

Description

### Overview
We need to create a defined structure for documenting each platform so that the documentation is consistent between platforms and that all team member know how to create new documentation.

### Details
The purpose of the documentation is so that a new developer can get up to speed quickly when addressing an issue about that platform, and the person making the issue doesn't have to reiterate all the resources.

The documentation will contain
- usage details
- issues
- resources

### Action Items
- [x] Identify what kind of information we need
- [x] Where It's going to go in the wiki
- [x] What templates are needed.
- [x] Release dependency on this issue for #70

### Resources/Instructions
https://github.com/hackforla/tables/blob/main/README.md
https://github.com/hackforla/tables/tree/main/dev-docs

#### What info we need int the documentation

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.