bruits / bruits/maudit

README could use some more information

Open Beginner friendly
#87 0 comments 0 reactions 0 assignees View on GitHub
good first issue
Dominant language
Rust
Stars
172
Forks
7
Avg merge
6h 42m
Merged PRs (30d)
5

Description

### Version

N/A

### Describe the Bug

The README is currently a bit barebones, I think it scares people away a bit. I think it'd be great to describe at least the following:

- Quick Start
- Development

The Quick Start section should be a smaller https://maudit.org/docs/quick-start/ essentially, just going over installing the CLI, init a new project and how to run the dev server. [Astro's install section](https://github.com/withastro/astro#install) is a good reference here.

For the development section, just a summary of the commands would be enough. [Dodeca's](https://github.com/bearcove/dodeca#development) is a good reference

### Participation

- [x] I am willing to submit a pull request for this issue.

Contributor guide

Open the contributing guide

Research direction

Start with the repository README and the linked maudit quick-start documentation. Add concise Quick Start and Development sections covering CLI installation, project initialization, running the development server, and the relevant development commands, using the linked Astro and Dodeca examples as references. Done means the README explains these workflows clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.