histoire-dev / histoire-dev/histoire

Svelte Auto-Codegen / Auto-Docs with sveld

Open
#254 1 comment 5 reactions 0 assignees View on GitHub
enhancement: to triage
Dominant language
TypeScript
Stars
3.6k
Forks
212
PR merge metrics
No merged PRs in 30d

Description

### Clear and concise description of the problem

Histoire doesn't have Auto-CodeGen or Auto-Docs for Svelte.

### Suggested solution

I recently came across `sveld` _(auto documentation for Svelte)_ and wanted to share with Histoire team. Perhaps you guys can borrow some ideas here.

**Sveld Demo:** https://sveld.onrender.com
**Sveld Repo:** https://github.com/carbon-design-system/sveld

### Alternative

_No response_

### Additional context

_No response_

### Validations

- [X] Follow our [Code of Conduct](https://github.com/histoire-dev/histoire/blob/main/CODE_OF_CONDUCT.md)
- [X] Read the [Contributing Guidelines](https://github.com/histoire-dev/histoire/blob/main/CONTRIBUTING.md).
- [X] Read the [docs](https://histoire.dev/guide/).
- [X] Check that there isn't [already an issue](https://github.com/histoire-dev/histoire/issues) that requests the same feature to avoid creating a duplicate.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the linked sveld demo and repository alongside Histoire's existing Svelte support and documentation. The issue names no Histoire files, tests, entry points, or acceptance criteria, so the scope and validation for Svelte auto-code generation or documentation would need to be established before implementation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.