Interactive-Book icon indicating copy to clipboard operation
Interactive-Book copied to clipboard

Restructure README.md

Open schezfaz opened this issue 4 years ago • 4 comments

Current Status:

The README.md file covers the following topics:

  • Introduction the the project
  • Setting up development environment on local
  • Contribution history
  • Overview of the Interactive Book (contents, architecture, etc.)
  • Rules and guidelines for contributions
  • Code structure
  • Pop quiz introduction
  • Plugins
  • Jekyll Resources

which is a lot of content cluttered into one markdown file in my opinion.

Enhancement:

I believe it would add a lot more structure and clarity to any who visits this repository while finding their way around in order to the content they are looking for if we broke down the README.md file into separate markdown files, each covering a sub-topic. For example, we could have separate pages describing Contribution guidelines, Setting up the development environment, and so on.

The README.md would ofcourse also serve as a nav-map, redirecting the users to the pages they are most interested in.

Approaches:

There are two ways we could go about this:

  1. We could add the content as part of the repository's WIKI's.
  2. Create individual .md files that would be linked to from the README.md page.

I would like to work on this.

schezfaz avatar Jun 02 '20 16:06 schezfaz

how about a directory with all markdown files in there? and we can have a universal markdown file which as you said link to all these files present in some specific directory.

abhinavsri360 avatar Jun 03 '20 09:06 abhinavsri360

I think we must go with the second option : separate md files

YashKumarVerma avatar Jun 11 '20 03:06 YashKumarVerma

Thanks, working on it!

schezfaz avatar Jun 13 '20 11:06 schezfaz

@schezfaz Let me know if you need any support or want to divide the task.

abhinavsri360 avatar Jun 13 '20 12:06 abhinavsri360