Skip to content

Home

Jump to bottom
Luke Ruud edited this page Jun 2, 2023 · 3 revisions

Welcome to the PythonProjectTemplate wiki! This is a quick guide on how to set up a wiki for your project. Well organized wikis are essential in open source projects, as they serve as documentation directories.

The two most important parts of a wiki are a descriptive home page and a side bar for documentation. This is an example of a good wiki, which has both of these elements.

Making a home page

Like all good documentation, a good home page finds the right balance between concise and descriptive. The home page is usually the least technical piece of documentation in your repo, so don't be afraid to write casually and explain more setup instructions than you would in your README.

  • A short, descriptive paragraph about the project under the header
  • Links to resources and support forums
  • A simplified guide about getting started with the project with the following elements:
    • An installation guide for required packages
    • A list of which environments are supported
    • A link to the README

List of Resources:

  • Resource 1
  • Resource 2
  • Resource 3

Alphabetized List of Documentation:

  • A
  • B
  • C
Clone this wiki locally