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

The INSTALLATION.md file needs a newly generated table of contents #1234

Closed
palisadoes opened this issue Dec 21, 2023 · 6 comments
Closed

The INSTALLATION.md file needs a newly generated table of contents #1234

palisadoes opened this issue Dec 21, 2023 · 6 comments
Assignees
Labels

Comments

@palisadoes
Copy link
Contributor

Is your feature request related to a problem? Please describe.

  1. There are many missing table of contents (TOC) entries in the INSTALLATION.md file.
  2. Many of the existing TOC entries are under an inappropriate parent heading

This increases the risk of installation instructions being overlooked.

Describe the solution you'd like

  1. Add the missing table of contents (TOC) entries in the INSTALLATION.md file.
  2. Adjust the resulting TOC entries under the appropriate parent headings
  3. Ideally, the auto-generation of the TOC should be automatic as part of the git process

Describe alternatives you've considered

  • N/A

Approach to be followed (optional)

  • Consider using a markdown TOC autogenerator

Additional context

  • N/A

Potential internship candidates
Please read this if you are planning to apply for a Palisadoes Foundation internship PalisadoesFoundation/talawa#359

@aialok
Copy link
Contributor

aialok commented Dec 22, 2023

@palisadoes I would love to work on this issue : )

@Cioppolo14
Copy link
Contributor

@aialok Our policy is to assign no more than two issues to each contributor across all repositories. This way everyone gets a chance to participate in the projects. We sometimes give exceptions for more urgent cases and sometimes we lose track, but the policy stands. You have reached your limit, please wait until your existing issues are closed before requesting more issues. You could unassign yourself from one of the other issues too.

@aialok
Copy link
Contributor

aialok commented Dec 22, 2023

I am already done with my one of the issue just pull request need to merge : )

@aialok
Copy link
Contributor

aialok commented Dec 24, 2023

  • Hey @Cioppolo14 . I have implemented this feature in my own repository, and it's working fine. However, I still have some things to ask about:

    • Considering a New npm Package:
      I'm thinking about adding a new npm package to help automatically create a table of contents. Ishould I go for it ?

    • About markdown-toc npm package:
      I'm using markdown-toc, but some of its depedency has not been updated

      Screenshot from 2023-12-25 00-45-23

    • Ways to Automate Table of Contents:
      I'm looking at two ways to automatically generate a table of contents:
      - Adding a script to GitHub Actions workflows.
      - Setting up a husky pre-commit hook .

@palisadoes
Copy link
Contributor Author

Yes use the markdown package. Automation is best. It's a non-critical package, so we can take a chance on updates

@aialok
Copy link
Contributor

aialok commented Dec 25, 2023

Yes use the markdown package. Automation is best. It's a non-critical package, so we can take a chance on updates

Okay alright, I am going with husky pre commit for auto generation of toc on commit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants