Skip to content

[doc] Change titles for selected syntax

Tim McMackin requested to merge tpm/doc-title-contextualization into dev

Motivation and Context

!3197 changes titles in the sidebar based on the selected language. We also need to change the titles of the relevant topics to match.

Description

Similar to !3197, this swizzles the React component for the page and changes the title if both of these are true:

  • syntax is set to JsLIGO
  • the page has a front matter item named jsligoTitle

Preview:

cameligo-decorators-title

jsligo-decorators-title

Component

  • compiler
  • website
  • webide
  • vscode-plugin
  • debugger

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Performance improvement (non-breaking change that improves performance)
  • None (change with no changelog)

Changelog

Updates the title of the Decorators/Attributes doc page so it shows the correct term based on the selected language

Checklist:

  • If a new syntax has been introduced, put a message on slack ligo-lsp
  • Changes follow the existing coding style (use dune @fmt to check).
  • Tests for the changes have been added (for bug fixes / feature).
  • Documentation has been updated.
  • Changelog description has been added (if appropriate).
  • Start titles under ## Changelog section with #### (if appropriate).
  • There is no image or uploaded file in changelog
  • Examples in changed behaviour have been added to the changelog (for breaking change / feature).

Merge request reports