ynput / ynput/ayon-documentation
CLean up Project anatomy documentation
Open
Nobody has claimed this yet.
type: enhancement
- Dominant language
- TypeScript
- Stars
- 12
- Forks
- 13
- PR merge metrics
- No merged PRs in 30d
Description
Is there an existing issue for this?
- I have searched the existing issues and added correct labels.
Please describe the feature you have in mind and explain what the current shortcomings are?
CLean up Project anatomy documentation
https://help.ayon.app/en/help/articles/3815114-project-anatomy
Suggested implementation?
No response
Describe alternatives you've considered:
No response
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
Start by reading the Project anatomy article at https://help.ayon.app/en/help/articles/3815114-project-anatomy. Compare its current content with the project's intended documentation standards, then identify and correct the outdated or unclear parts. Done means the article has been cleaned up, though the issue does not define specific changes or tests.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100