Document Hyper architecture
Open
Nobody has claimed this yet.
🎨 Type: Enhancement
💛 Priority: Medium
help wanted
- Dominant language
- TypeScript
- Stars
- 44.7k
- Forks
- 3.6k
- Avg merge
- 21m
- Merged PRs (30d)
- 1
Description
I think we should document the overall architecture to help new contributors get up to speed! I still don't have a grasp on the architecture. 😟 I'd be great to have some block diagrams and flow charts showing how the following are related and connected: hterm, electron, redux, ui presentation, etc.
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
The issue names no files or tests. Start by locating the entry points for hterm, Electron, Redux, and the UI presentation layer, then trace how they connect. Done means contributor-facing architecture documentation with block diagrams and flow charts covering those relationships.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- electron, redux, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 28/100