Skip to content

Make Learning Directory README files uniform #247

@JamieBort

Description

@JamieBort

task:
Make Learning Directory README files uniform, meaning make them have the same headings in the same order with the same phrasing under each heading.

To this end, look into a

  • bash/git command that searches for

    • all the (sub-)directories without a readme file.
    • and all the (sub-)directories who's readme file differs from the template.
  • bash command that can add the missing

    • headings
    • starter phrases such as
      • <!-- The purpose of this directory is to [...]. -->
      • and This directory houses information about [name_of_the_directory_that_this_readme_file_is_in].

See also a bullet under https://github.com/JamieBort/Learning-Directory/tree/master/Languages/Bash#use-cases

Possibly related: #196

Possibly related: https://github.com/JamieBort/Digital-Knowledge-Base/blob/main/journals/2024_08_06.md#later-create-a-keyboard-shortcut-for-readmemd-files-that-are-used-in-each-sub-directory-of-the-professional-development-learning-directory-66b27b23-e610-4892-8bca-702431926e9d-repo

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions