jargons.dev icon indicating copy to clipboard operation
jargons.dev copied to clipboard

[FEATURE]: Documentation Structure and Clarity Improvements

Open AyendiSimeon1 opened this issue 1 year ago • 1 comments

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

AyendiSimeon1 avatar Nov 16 '24 22:11 AyendiSimeon1

Considering the PR that was closed for this issue, It looks as though this issue sorta overhauls the entire documentation.

This isn't the kind of approach we'd want to take in attempt to improve the documentation, we prefer a section-by-section improvement instead.

With the section-by-section improvement, we can be sure that changes are made well overtime collecting the view of more contributors.

babblebey avatar Nov 19 '24 12:11 babblebey