jargonsdev / jargonsdev/jargons.dev

[FEATURE]: Documentation Structure and Clarity Improvements

Open
#107 1 comment 0 reactions 0 assignees View on GitHub
:red_circle: wontfix
Dominant language
MDX
Stars
56
Forks
45
PR merge metrics
No merged PRs in 30d

Description

### Is this a unique feature/idea?

- I have checked "open" AND "closed" issues and this is not a duplicate

### Is your feature request related to a problem/unavailable functionality? Please describe.

**The current documentation lacks clear structure and essential information, making it difficult for new contributors to get started. Specifically**:

The hierarchy and organization are unclear, making information hard to find
Setup instructions lack context and proper error handling guidance
Contribution workflows are not thoroughly explained
Missing important sections like community engagement and troubleshooting
Inconsistent formatting and markdown usage throughout

These issues create friction for new contributors and may discourage participation in the project.

### Proposed Solution

**Restructure the documentation to follow a clear, hierarchical format with comprehensive information**

**Improved Structure**

Clear main sections with proper heading hierarchy
Logical flow from introduction to advanced topics
Consistent formatting and spacing

**Enhanced Content**

Detailed feature overview
Comprehensive setup instructions with troubleshooting
Clear contribution guidelines with step-by-step processes
Added community and support sections

**Technical Improvements**

Proper markdown formatting
Working links to all referenced resources
Code block syntax highlighting
Clear setup script documentation

### Screenshots

_No response_

### Do you want to work on this issue?

Yes

### If "yes" to above, please explain how you would technically implement this

**Update Main README.md**

- Implement new structure using proper markdown syntax
- Add missing sections and improve existing ones
- Update all links and references

**Create Additional Documentation**

- Create CONTRIBUTING.md with detailed guidelines
- Add SETUP.md with comprehensive setup instructions
- Create TROUBLESHOOTING.md for common issues

Contributor guide

Open the contributing guide

Research direction

Start by reviewing README.md and auditing its heading hierarchy, links, setup guidance, and contribution workflow. Then define the content for CONTRIBUTING.md, SETUP.md, and TROUBLESHOOTING.md; the work is done when the documentation has consistent Markdown, complete contributor guidance, and the proposed sections and references are present.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.