Features list

Product description

This application will allow a user to create and edit markdown files in a repository.

Features list

This will be a living list of features we should add to the project

• Log in and out with Github
• See list of user repositories
• See tree structure of a selected repository's doc folder
• Create files and folders in the selected projects doc folder
• Reorganize folders and files in the selected projects doc folder
• Edit files with markdown
• See live rendered markdown
  This is the basic UI we are thinking of creating:
  

Modes Breakdown

• Switch to Markdown mode

  • View list of remote repositories
  • Load a repository (clone to server)
  • View documents in repository
  • CRUD operations on documents in repository
  • Markdown editor
  • Markdown Github live preview

• Switch to Config mode

  • Select repository (from cloned projects)
  • action buttons:
    • Generate docs template for project action button
    • Deploy static site to GH pages
    • Preview static site in browser
  • index.html editor

Helpful links

https://developer.github.com/apps/differences-between-apps/

The issue is a broad roadmap covering Markdown and Config modes, with no files, tests, or entry points named. Start by reviewing the repository structure and breaking the feature list into a narrowly scoped task; completion criteria are not defined here.