Skip to content

Remove legacy Kramdown topic-type IAL markers ({:.concept}, {:.section}, …) rendering as literal text #274

@miharp

Description

@miharp

Summary

The openvox 8.x docs contain legacy Puppet-docs Kramdown topic-type IAL markers{:.concept}, {:.section}, {:.task}, {:.reference}, {:.example} — left over from the old DITA-style Puppet documentation build. The current jekyll-vitepress-theme has no styling for these classes, and where the marker isn't attached to an adjacent block it renders as literal text on the page.

Example (the cron section of the core-types cheatsheet renders a literal {:.concept} line above the user heading):

`environment`, `name`, `special`, `target`, `user`.

{:.concept}        ← shows verbatim on the rendered page

### user

Scope

147 occurrences across 17 files, all in docs/_openvox_8x/:

Marker Count
{:.section} 68
{:.concept} 42
{:.task} 18
{:.reference} 10
{:.example} 9

Affected files:

  • cheatsheet_core_types.md (28)
  • modules_installing.markdown (16)
  • config_about_settings.markdown (14)
  • openvox_strings_style.md (14)
  • modules_publishing.markdown (13)
  • dirs_modulepath.markdown (10)
  • openvox_strings.md (9)
  • modules_fundamentals.markdown (7)
  • dirs_confdir.markdown (6)
  • modules_metadata.md (6)
  • cheatsheet_module.md (5)
  • dirs_codedir.markdown (5)
  • dirs_manifest.markdown (4)
  • dirs_vardir.markdown (4)
  • dirs_ssldir.markdown (3)
  • install_windows.markdown (2)
  • config_file_auth.markdown (1)

(Other collections — openvox-server, openvoxdb, openfact, openbolt — have none.)

Proposed fix

Remove all the standalone {:.<type>} IAL lines. They classified topics in the old Puppet build (concept/task/reference); the current theme applies no styling to them, so they add no value and — when orphaned — render as visible noise.

Mechanical to do (delete lines matching ^\{:\.[a-z_-]+\}$), but worth a quick visual pass per file to confirm nothing relied on them and to tidy the now-adjacent blank lines. Good opportunity to also clear markdownlint debt in the touched files.

Surfaced while reviewing the #262 workstream-E link fixes (#273).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions