hackforla / hackforla/peopledepot

Reconcile wiki and mkdocs

Open
#362 5 comments 0 reactions 0 assignees View on GitHub
complexity: small feature: docs: PD team documentation PII: FALSE ready for dev lead role: product role: writing s: PD team size: 0.5pt
Dominant language
Python
Stars
14
Forks
37
Avg merge
9d 15h
Merged PRs (30d)
5

Description

### Overview

We need to make it clear what goes into the wiki vs. mkdocs. And there needs to be some links to go both ways.

### Action Items

- [ ] identify places and link to mkdocs from the wiki
- [ ] identify places and link to the wiki from mkdocs
- [ ] create wording for what should go into the wiki vs. mkdocs and put it in sensible places in each document

### Resources/Instructions

#### wiki links to [mkdocs](https://hackforla.github.io/peopledepot/)

- main page?

#### mkdocs links to [the wiki](https://github.com/hackforla/peopledepot/wiki)

- README.md
- contributing?

#### what goes in the wiki vs. mkdocs

We use the [project wiki](https://github.com/hackforla/peopledepot/wiki) to hold information relating to project management and the [MkDocs site](https://hackforla.github.io/peopledepot/) for information about the project code.

The MkDocs site is meant to be updated along with code changes. The documentation should reflect what the latest code does.

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.