beeware / beeware/podium

Convert documentation site to Markdown

Open
#86 1 comment 0 reactions 1 assignee Claimed by @kattni View on GitHub
enhancement
Dominant language
JavaScript
Stars
211
Forks
36
Avg merge
6h 49m
Merged PRs (30d)
1

Description

### What is the problem or limitation you are having?

The current documentation is a RestructuredText site written using Sphinx. BeeWare now uses Markdown and MkDocs.

### Describe the solution you'd like

Convert rST files to Markdown, and convert project to use MkDocs.

Once completed, assign podium.beeware.org to the documentation.

The documentation on Briefcase and Toga can be used as a template for how to set up a project.

### Describe alternatives you've considered

None. We need to be consistent in our usage of MkDocs.

### Additional context

This will bring it in line with the rest of the BeeWare projects and documentation.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.