loopbackio / loopbackio/loopback-next
Illustrate the handshake between an application and a component
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5.1k
- Forks
- 1.1k
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 27
Description
This is a follow-up for https://github.com/strongloop/loopback-next/issues/5337 and https://github.com/strongloop/loopback-next/pull/5122#discussion_r412537642 in particular.
Create a diagram to show the handshake between an application and a component as well as typical artifacts exported from a component.
Add the diagram to our docs for component authors, e.g.
Contributor guide
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
Read the linked follow-up issue and PR discussion first, then review docs/site/migration/components/overview.md, docs/site/Extending-LoopBack-4.md, and docs/site/Components.md. Create a diagram covering the application–component handshake and typical exported artifacts, and add it to the component-author documentation so the requested workflow is illustrated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100