Home

Documentation for MusicBrainz Picard

This project was created with the intent of eventually developing a comprehensive User Guide for MusicBrainz Picard, a full-featured, cross-platform music file tagging system using metadata from MusicBrainz.

This project is intended to augment the documentation originally appearing on the Picard website with additional detail and a structured approach, and to provide the resulting User Guide in formats suitable for both on-line and off-line reference.

This documentation project is open source and provided under CC0 1.0. To view a copy of this license, visit https://creativecommons.org/publicdomain/zero/1.0.

The project currently produces the on-line documentation in ReadTheDocs format theme using Sphinx. Stand-alone PDF and ePub documents are also being produced. The latest build of the documentation produced by this initiative can be viewed on the web page.

Information in the Wiki Pages

We have tried to include additional information about the project in the wiki pages listed to the right. These include:

• Contributing to the Project
  This page provides some information regarding the opportunities for contributing to the Picard Documentation project, as well as the steps that can be used to provide your contributions.

• Project Roles & Responsibilities
  This page provides an overview of the roles that contributors play within the Picard Documentation project along with a brief description of the responsibilities and expectations of each of the roles.

• Project Workflow
  This page provides a (simplified) description of the workflow to implement a change to the documentation.

• Publishing a New Version
  This page provides a description of the process to follow when a new version of the documentation is to be published in support of a new release of MusicBrainz Picard.

• Publishing Logic
  This page builds on the previous Publishing a New Version page, and provides a detailed description of the automated publishing process that has been developed for this documentation project. This includes an example scenario with step-by-step actions.

• Repository Structure
  This page provides a detailed description of the branch and directory structure used for this Picard Documentation project repository. This will be of interest to anyone planning to contribute to the project.

• Website 404 Redirection
  This page describes in detail the processing performed in an attempt to automatically locate and display the requested documentation page before returning a 404 File Not Found message.

---