Skip to content

Conversation

@SirkoS
Copy link
Contributor

@SirkoS SirkoS commented Sep 4, 2025

Summary of the discussion

addresses #287 "Documentation typos and out-of-sync"

Fixed two issues with the documentation of metadata keys in metadata_key_description.md files:

  • Examples included an additional space in the closing div tag, causing it to be rendered on the documentation:
    image
  • the examples for resource.temporal.resolutionValue and resource.temporal.resolutionUnit were out of sync with the examples provided in the schema itself

Type of change (CHANGELOG.md)

  • minor change in doc - no entry needed?

Workflow checklist

Automation

PR-Assignee

  • 🐙 Follow the workflow in CONTRIBUTING.md
  • 📝 Update the CHANGELOG.md
  • 📙 Update the documentation
  • 🐙 Assign a reviewer to the PR

Reviewer

  • 🐙 Follow the Reviewer Guidelines
  • 🐙 Provided feedback and show sufficient appreciation for the work done

@jh-RLI
Copy link
Contributor

jh-RLI commented Sep 10, 2025

Hi @SirkoS
thanks alot for that fix :) As we don't really document pur documentation changes here, this is good as it is.

@jh-RLI jh-RLI merged commit a59f0e2 into OpenEnergyPlatform:develop Sep 10, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants