Skip to content

checklist: Sweep on strings formatting and Kramdown ToCs #126

Open
@wion

Description

@wion

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.

  • /brand
  • /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
  • /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
    • /tag-basics ; now Learning about tags, might become the index file in that directory?
  • /themes (recycling to /build)

Metadata

Metadata

Assignees

No one assigned

    Labels

    all handsAll doc team members can help as time allows; applicable to 'checklist' issues.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions