AOSSIE-Org / AOSSIE-Org/Resonate-Backend

Improve README Formatting and Documentation Clarity

Đang mở
#161 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
Ngôn ngữ chính
JavaScript
Star
43
Fork
120
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

Title

Improve README Formatting and Documentation Clarity


📌 What is currently there

The README currently includes:

  • Project overview
  • Links to the Flutter App and Backend repositories
  • Environment setup instructions
  • Setup guidance for LiveKit and Appwrite
  • List of backend functions
  • Communication channels

The overall structure is clear and informative. However, there are minor formatting inconsistencies, spelling issues, and documentation improvements that can enhance clarity and professionalism.


🔍 What can be improved

  • Repository Link Consistency: The backend repository link in the “two repositories” section is not clickable.
  • Clone Instructions:
    • The README suggests cloning the main repository instead of cloning the contributor’s fork.
    • The .git suffix is missing (optional but standard practice).
  • Heading Formatting: ## Environment Setup : contains an unnecessary colon.
  • Brand & Terminology Formatting:
    • “livekit-cloud” → “LiveKit Cloud”
    • “self host” → “self-host”
    • “docker image” → “Docker image”
  • Function Naming Consistency:
    • discussion-isTime-checker
    • database-cleaner
    These entries are not formatted consistently with the other functions.
  • Grammar Improvements: Minor grammatical issues in the discussion time checker description.

🛠 What I will do

  • Make the backend repository link clickable
  • Update clone instructions to guide contributors to clone their fork
  • Fix heading formatting inconsistencies
  • Standardize terminology and capitalization
  • Improve grammar in function descriptions
  • Ensure consistent formatting across all function entries

🎯 Why this matters

  • Improves readability
  • Makes onboarding smoother for new contributors
  • Enhances documentation professionalism
  • Maintains consistency across the repository

I would like to work on implementing these improvements.
Kindly assign this issue to me.

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.