Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a table of contents to the readme files #254

Open
1 task
JamieBort opened this issue Mar 13, 2024 · 1 comment
Open
1 task

Add a table of contents to the readme files #254

JamieBort opened this issue Mar 13, 2024 · 1 comment

Comments

@JamieBort
Copy link
Owner

JamieBort commented Mar 13, 2024

Add a table of contents to the readme files

Todo

  • Research how to autogenerate them. See resources in the Associated section below.

Status

Associated

Repo

Here
https://github.com/JamieBort/Learning-Directory/tree/master/Git/markdown#resources-to-explore

and the todo item here
https://github.com/JamieBort/Learning-Directory/tree/master/Git/markdown#resources-to-explore

and
https://github.com/JamieBort/Learning-Directory/blob/master/Meta/templates/readme_templates/repo_directory_readme_template.md

Associated Trello card

Issues

JamieBort added a commit that referenced this issue Mar 13, 2024
@JamieBort
Copy link
Owner Author

From https://trello.com/c/Ka1BOJb5/1315-update-the-learningdirectory-readme-file


The body:

#Update the LearningDirectory README file

Such that the [Explanation of files and directories](https://github.com/JamieBort/LearningDirectory#explanation-of-files-and-directories) section reflects what is actually in that directory, rather than 
>Courses
Coding Challenges and
Projects

https://github.com/JamieBort/LearningDirectory

Add a table of contents:
https://trello.com/c/Ka1BOJb5/1315-update-the-learningdirectory-readme-file#comment-65abd42b7446cb2ef8e78948

### Next Steps

### Status

### Associated Links

* https://trello.com/c/vx0oVl0e/237-learningdirectory-professional-development

* Link to card
https://trello.com/c/CL6Lkosc/1678-trello-template
Link to `Simple` in the Activity
https://trello.com/c/CL6Lkosc/1678-trello-template#comment-633b70e875207c00f6ee4a64

**Completed**  - See `Completed` in the Activity below:
[link]

### Master Card

`README for each repo` in the Activity of the https://trello.com/c/gZJQgnvv/360-update-github Trello card:
https://trello.com/c/gZJQgnvv/360-update-github#comment-65b1341556bbfda82f217d64

~~https://trello.com/c/NnqWRZIE/158-clean-up-github-repositories~~

And from: https://trello.com/c/Ka1BOJb5/1315-update-the-learningdirectory-readme-file#comment-65abd42b7446cb2ef8e78948

###Maybe add a table of contents

See the [README](https://github.com/JamieBort/LearningDirectory/blob/master/README.md) file in the `LearningDirectory` repo:
>Add a [Table of Contents](https://stackoverflow.com/questions/18244417/how-do-i-create-some-kind-of-table-of-content-in-github-wiki) to this file. (?)

See also `Screen Shot 2024-01-20 at 09.09.55.png`.

There are many (3+) options for generating one via this link above. 

JamieBort added a commit that referenced this issue Mar 13, 2024
JamieBort added a commit that referenced this issue Mar 15, 2024
JamieBort added a commit that referenced this issue Mar 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant