vocabulary-legacy icon indicating copy to clipboard operation
vocabulary-legacy copied to clipboard

[Feature] Create a `/guides` directory to track beginner friendly documentation and help specific to this project

Open possumbilities opened this issue 1 year ago • 0 comments

Problem

There are instances where newcomers/beginners would benefit from more specific and detailed instructions related to this project than what is present in the standard README.md, but expanding the README.md file to accommodate this could make it bloated and confusing.

Description

To resolve this we're going to add a /guides directory with an explainer README.md file within it, and allow this folder to contain various guides for this repository, as relevant to newcomers and beginners.

Some examples might include:

  • How to create new Actions workflows
  • Understanding the importance of Semantics

Guides can include detailed instructions and/or relevant links to resources on the web, such as tutorials, dev guides, etc. to help people better understand how to contribute to this project as a beginner.

Additional context

  • https://github.com/creativecommons/search/issues/110

Implementation

  • [x] I would be interested in implementing this feature.

possumbilities avatar Oct 24 '22 19:10 possumbilities