Files
python-MIT-repo-template/.github/ISSUE_TEMPLATE/03-set-up-project-wiki.md
T

991 B

name, about, title, labels, assignees
name about title labels assignees
3. Set up project wiki First step for a new project — publish the wiki template pages. Set up project wiki
setup
documentation

Task

Publish the pages from wiki/ to the repository's actual wiki (or your team's wiki tool), and fill each one in for this project.

Steps

  • Copy wiki/Home.md, Getting-Started.md, Architecture.md, Project-Specification.md, Value-Stream-Mapping.md, and FAQ.md into the live wiki
  • Fill in Home with real links (repo, issue tracker, CI) and conventions
  • Fill in Getting Started with real install/run/test instructions
  • Link the approved project specification and value stream map from their wiki pages
  • Remove the "how to use this template" notes once pages are populated

Definition of done

  • Wiki is live and linked from the README
  • Getting Started page is accurate enough that a new contributor can follow it unaided