Skip to content

Refactor README files to use a syntax that can be parsed in an automated way #14

Description

@Faaizz

Refactor README files to use a syntax that can be parsed in an automated way. Such that a website can be generated from thier contents.

An approach would be that each README file:

  • has a 2nd level heading (##) with the title "Introduction" that gives a description of the directory's contents
  • has a 2nd level heading (##) with a list of topics relating to the content of the directory

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions