Home

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. If your README is very comprehensive, just include a hyperlink to your README from the wiki.

• 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 for further information

Making a Documentation Bar

The functional part of the wiki is its role as a documentation directory. Within the side bar, include an organized list of all documentation for the project. If a contributor is struggling with a particular element, they should be able to reference the corresponding section in the wiki for help.

For example, if your project uses a computer vision model, you should link to documentation about the model.

Note: You can and should link to documentation or resources you didn't write for general topics. If you found a particular Stack Overflow forum that was helpful to your understanding of the project, it's likely contributors will also find it helpful.