OpenDevicePartnership / OpenDevicePartnership/OpenDevicePartnership.github.io
Dynamic Repository Diagrams
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1
- Forks
- 10
- Avg merge
- 5d 22h
- Merged PRs (30d)
- 1
Description
The Projects landing page has 3 main links for P (Patina), EC, and ES (EC Services) which bring up a page with What, Why, Who, and a repository diagram.
This task covers improvements for those diagrams:
- Create an engine that auto-generates the diagram each time the user opens the page instead of relying on a user updated jpg. Maybe pull topics from each repo for determining how to use the URLs?
- Add text to the auto-generated diagram to explain what it is and how to read it. The text needs to be geared to a new engineer browsing the web site.
- Create an action in this repo that creates a bug if any repository is found that does not provide the necessary hooks for the diagram engine.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Inspect the Projects landing page and its links for Patina, EC, and EC Services, then trace how the current repository diagrams are provided. Define the diagram engine, newcomer-oriented explanatory text, and repository validation needed; done means diagrams are generated on page access and an automated action reports repositories missing the required hooks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, rust
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100