adorsys / adorsys/status-list-server
EPIC: Documentation Architecture, Contributor Onboarding & Quality Governance
- Linguagem predominante
- Rust
- Estrelas
- 22
- Forks
- 5
- Merge médio
- 2d 6h
- PRs com merge (30d)
- 47
Descrição
## Overview
This sub-EPIC provides a first-class onboarding and documentation experience for both developers and production operators, along with automated AI-assisted development governance.
## Goals
1. **Contributor Experience**: Purify `CONTRIBUTING.md` with accurate toolchain guidance and clear architectural boundaries.
2. **README Refresh**: Streamline `README.md` into a 60-second quickstart, delegating detailed operator and deployment guides to dedicated files.
3. **Asset Organization**: Move static diagram assets out of root into `docs/assets/`.
4. **Documentation Platform**: Build and publish a cohesive Rust-book-style documentation site
5. **Quality Gates**: Establish automated AI-assisted development governance and quality checks
Guia de contribuição
Direção de pesquisa
Start by reading `CONTRIBUTING.md` and `README.md`, since those files are explicitly called out, then inspect the current docs layout and root-level diagram assets to determine what can move to `docs/assets/`. Next, look for existing docs-site configuration/workflow files in the repository to understand how any Rust-book-style publication is currently handled. There are no tests or commands named in the issue; done means onboarding and quickstart docs are updated, assets are relocated under `docs/assets/` with references fixed, and the quality governance/docs architecture is documented.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- rust
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Status de atividade
- Ativa
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 30/100