search

IBM / cics-bundle-maven

The plugin to build and deploy CICS bundles in a Maven build.
https://ibm.github.io/cics-bundle-maven/plugin-info.html
Eclipse Public License 2.0
18 stars 25 forks source link

Add TOC to README #158

Closed ind1go closed 3 years ago

ind1go commented 3 years ago

@vera-chan I'd appreciate your thoughts on this one.

The idea is to turn what's become quite a long README into something a little more consumable.

I've (manually) created a TOC for the different heading sections. Mostly it's word-for-word, though I've also used a little artistic licence to collect all the plugin-related sections together.

Note that if we were to use this format we'd have to keep the TOC in step with the content manually, and we'd have to be aware of breaking the links by changing the header titles (as the anchors are generated from the header titles).

Plus a couple of little tweaks for US English, misspelling, and structure.

vera-chan commented 3 years ago

@ind1go Hi Ben, I think this is a good idea. BTW, did you check how it will look like in the generated GitHub pages (I suppose it shall be OK, just to confirm)? For manual maintenance, I guess we can add a comment in the file saying sth like if you change the headings, you need to update the ToC accordingly?

ind1go commented 3 years ago

Thanks @vera-chan.

I think the Pages render should be unaffected.

I've just added a comment to aid future editors, if you wouldn't mind re-reviewing.

vera-chan commented 3 years ago

Approved! @ind1go