README Table of Contents is out of date and process documentation is absent

[TimidRobot]

Description

README Table of Contents is out of date and process documentation is absent.

Reproduction

See the Table of Contents - README.md. It does not match the headings in the document.

Expectation

Instructions for regenerating the ToC should be included

Resolution

• [ ] I would be interested in resolving this bug.

[avats-dev]

Hey @TimidRobot , As there is no automated support provided by github for README TOC, I think we should hardcode this as this repo's outline of README doesn't changes that frequently (see here).

Alternatively for the greater good:

• We could use a github action (self created or one from marketplace) to update README after a fix interval.
• Another better but harder approach would be to set up a python script in here to update the TOC of each repo from CC org like daily, or with some schedule.

So, what do you think?

Also @kgodey, @bhumijgupta for suggestions!

[TimidRobot]

Hey @TimidRobot , As there is no automated support provided by github for README TOC, I think we should hardcode this as this repo's outline of README doesn't changes that frequently (see here).

If the existing TOC wasn't generated with a utility, I think this issue is invalid.

Alternatively for the greater good:

• We could use a github action (self created or one from marketplace) to update README after a fix interval.
• Another better but harder approach would be to set up a python script in here to update the TOC of each repo from CC org like daily, or with some schedule.

I think this idea has merit. The better place to discuss it is in the creativecommons/ccos-scripts repository's issues.