Update/create documentation
- Dominant language
- TypeScript
- Stars
- 24
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Description
The existing documentation is only provided in the GitHub repository's README.md and is insufficient.
An appropriate and extensive documentation about setting up, configuring and using the MeshUI is required.
* Language configuration
* Base URI configuration
* Keycloak configuraton (once supported)
* General introduction (Admin Area, Edit Area)
* Feature Overview (e.g. Bulk Upload )
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing README.md and the current MeshUI screens and configuration paths. Document setup, language and base URI configuration, the planned Keycloak configuration once supported, the Admin Area and Edit Area, and features such as Bulk Upload. Done means the repository contains extensive documentation covering each requested topic.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- angular, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100