textpattern.github.io icon indicating copy to clipboard operation
textpattern.github.io copied to clipboard

checklist: Sweep on strings formatting and Kramdown ToCs

Open wion opened this issue 5 years ago • 1 comments

Situation

Docs in /build, /brand, /development, /setup, /tags need a sweep for updating interface strings against easier formatting standards... https://docs.textpattern.com/brand/user-docs-guide#formatting-interface-strings).

And replacing manually-created contents lists (ToCs) with the follow lead-in line and kramdown syntax:

**One this page**:

* Table of contents
{:toc}

This Kramdown notation generates the lists automatically but leaves out h1 (titles), and h5 and h6 headers, which, even if they are used (but should be avoided when possible), don't need to be loading up the ToC too.

Checklist

Check off page when sweeped. Add any missing page. Only when the container folder is checked can the doc lists be removed, meaning the entire directory has been sweeped.

  • [x] /brand
  • [x] /build (strings and tocs done as new docs go in)
  • [ ] /development
    • [ ] admin-side-events-and-steps.md
    • [ ] admin-side-plugin-tutorial.md
    • [ ] contributing.md
    • [ ] core-callbacks-reference.md
    • [ ] database-schema-reference.md
    • [ ] index.md
    • [ ] plugin-template-help.md
    • [ ] plugin-user-help-guidelines.md
    • [ ] plugin-vs-core.md
    • [ ] public-side-plugin-tutorial.md
    • [ ] textpattern-source-code-repositories.md
    • [ ] the-pluggable-ui-function.md
  • [x] /setup (strings and tocs done as new docs go in)
  • [ ] /tags
    • [ ] /shortcodes
      • [ ] aside-quote-shortcode.md
      • [ ] custom-short-tags-and-shortcodes.md
      • [ ] download-link-shortcode.md
      • [ ] image-with-caption-shortcode.md
      • [ ] index.md
      • [ ] video-embed-shortcode.md
    • [x] /tag-basics ; now Learning about tags, might become the index file in that directory?
  • [x] /themes (recycling to /build)

wion avatar Nov 08 '19 17:11 wion

Notice: I have moved the dozens of offline FAQ docs that were clogging up the /faqs directory to _../recycle/needless-faqs. If ever needed for whatever reason, we can pluck them from there, but at least they are out of the way.

https://github.com/textpattern/textpattern.github.io/commit/dd8189e5df1ae286712c22da0fb0fef2a0379eb8

wion avatar Dec 01 '19 14:12 wion