mia-platform / mia-platform/console-sdk

[Feature]: Add information inside the monorepo files ".md"

Open
#4 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
8
Forks
0
PR merge metrics
No merged PRs in 30d

Description

### What would you like the Console SDK to do?

Currently, inside the mono repo, there are many file md that can be populated with some useful information

### Libraries

console-microfrontend-sdk

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the monorepo’s .md files and the console-microfrontend-sdk library to identify which documentation is incomplete. Clarify which files should be populated and what information each should contain; the work is done when the agreed files contain useful, accurate information.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.