Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reconcile wiki and mkdocs #362

Open
3 tasks
fyliu opened this issue Aug 14, 2024 · 0 comments
Open
3 tasks

Reconcile wiki and mkdocs #362

fyliu opened this issue Aug 14, 2024 · 0 comments
Labels
complexity: small All steps are laid out in detail so that someone new to the project can work on it feature: docs: PD team documentation documentation on PD team processes and architecture, etc. role: writing s: PD team stakeholder: People Depot Team size: 0.5pt Can be done in 3 hours or less

Comments

@fyliu
Copy link
Member

fyliu commented Aug 14, 2024

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

  • main page?

mkdocs links to the wiki

  • README.md
  • contributing?

what goes in the wiki vs. mkdocs

We use the project wiki to hold information relating to project management and the MkDocs site 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.

@fyliu fyliu added complexity: small All steps are laid out in detail so that someone new to the project can work on it feature: docs: PD team documentation documentation on PD team processes and architecture, etc. role: writing s: PD team stakeholder: People Depot Team size: 0.5pt Can be done in 3 hours or less labels Aug 14, 2024
@fyliu fyliu added this to the 5 - Team Workflow milestone Aug 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
complexity: small All steps are laid out in detail so that someone new to the project can work on it feature: docs: PD team documentation documentation on PD team processes and architecture, etc. role: writing s: PD team stakeholder: People Depot Team size: 0.5pt Can be done in 3 hours or less
Projects
Status: 🆕New Issue Review
Development

No branches or pull requests

1 participant