Adding a good explanation of what happens when initiating wing resource
Open
Nobody has claimed this yet.
✨ enhancement
- Dominant language
- TypeScript
- Stars
- 5.4k
- Forks
- 215
- Avg merge
- 2h 9m
- Merged PRs (30d)
- 27
Description
Feature Spec
We have complex resources. Most of them are composed of many, it could be really interesting to explain in detail what we chose, and why, to get developers a better understanding of what "building blocks" they are actually adding, it can be good if:
- They plan to interact with the components later
- They're adding custom resources, and want to know how ours works to prevent collision
- They want to know they won't be replaced by Wing, and that we can work together
- It will bring wing out of the "toy" state, as they'll recognize design pattern and boiler plate that they would use too/ at least make sense
Use Cases
information
Implementation Notes
No response
Component
Documentation
Community Notes
- Please vote by adding a 👍 reaction to the issue to help us prioritize.
- If you are interested to work on this issue, please leave a comment.
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
The issue names no files, tests, or entry points. Start by reviewing the existing documentation for Wing resources and defining which composed resources need explanation; done means documenting what is created, why the building blocks were chosen, and how custom resources can coexist without collisions.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100