Skip to content

Conversation

@olavoasantos
Copy link
Member

Closes #54

📑 Summary

This pull request includes updates to documentation files, primarily focusing on reorganizing file paths, adding new interface definitions, and updating references for consistency. The changes also introduce new interfaces and type aliases related to the environment module.

Documentation Updates and File Reorganization:

  • Renamed files under packages/core/docs/references/namespaces/Micra/ to packages/core/docs/references/@micra/namespaces/Micra/ and updated relative links accordingly for consistency. [1] [2] [3]

New Interfaces and Type Aliases:

  • Added documentation for the EnvironmentDefinition interface, which defines the schema and behavior of individual environment variables.
  • Introduced the EnvironmentEventMap interface, which describes events emitted by the environment, such as environment:changed and error.
  • Added the EnvironmentVariableData type alias to represent the expected type of environment variable values.

Reference Updates:

  • Updated links to source code definitions in multiple files to reflect the latest commit hash (d68b1ba299bb0ba5d2fa49fd403fe8866818f855). [1] [2] [3]

These changes improve the organization, clarity, and completeness of the documentation for the @micra/core package.

✅ Checks

  • My pull request adheres to the code style of this project
  • My code requires changes to the documentation
  • I have updated the documentation as required
  • All the tests have passed

@olavoasantos olavoasantos added the Type: docs Documentation only changes label Apr 20, 2025
@olavoasantos olavoasantos requested a review from Copilot April 20, 2025 22:02
@olavoasantos olavoasantos self-assigned this Apr 20, 2025
@changeset-bot
Copy link

changeset-bot bot commented Apr 20, 2025

🦋 Changeset detected

Latest commit: b14d31e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 5 packages
Name Type
@micra/event-emitter Patch
@micra/environment Patch
@micra/utilities Patch
@micra/error Patch
@micra/core Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR reorganizes the documentation for the Micra project to improve clarity and consistency. Key changes include renaming documentation file paths (e.g. updating paths from "namespaces/Micra" to "@micra/namespaces/Micra"), updating relative link references and commit hash values, and adding new documentation for the Environment module’s interfaces and type aliases.

Reviewed Changes

Copilot reviewed 54 out of 54 changed files in this pull request and generated no comments.

File Description
packages/environment/docs/explanation/*.md New detailed guides on how define(), set(), and validation work in the environment module.
packages/core/docs/references/* Updated link references and reorganization of documentation files to support the new naming conventions.
packages/core/docs/references/@micra/namespaces/Micra/* Added and updated interface and type alias documentation for improved clarity and consistency.

@olavoasantos olavoasantos merged commit 1e8371c into latest Apr 20, 2025
1 check passed
@olavoasantos olavoasantos deleted the docs/M1G1P03T03 branch April 20, 2025 22:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Type: docs Documentation only changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

M1G1P03T03 Document Environment Abstraction

2 participants