Skip to content

Enhance README with improvement suggestions#147

Open
Dippp10-ally wants to merge 1 commit into
fetchai:mainfrom
Dippp10-ally:patch-1
Open

Enhance README with improvement suggestions#147
Dippp10-ally wants to merge 1 commit into
fetchai:mainfrom
Dippp10-ally:patch-1

Conversation

@Dippp10-ally
Copy link
Copy Markdown

📝 Notes for Improving README Formatting & Structure

1. Improve Hierarchy & Readability

  • Ensure a clear heading hierarchy:

    • # Project Title
    • ## Overview
    • ## Features
    • ## Installation
    • ## Usage
  • Avoid skipping heading levels (e.g., jumping from ####).


2. Add a Quick Start Section (High Priority)

  • Include a minimal copy-paste runnable example near the top.
  • Reduce friction for new contributors/users.

Example structure:

## Quick Start
```bash
git clone ...
pip install ...
python run.py

3. Standardize Code Blocks

  • Always specify language for syntax highlighting:

  • Keep code blocks short and focused.

  • Avoid mixing multiple commands in one block unless necessary.


4. Improve Table & List Formatting

  • Use consistent:

    • Bullet style (- preferred over *)
    • Alignment in tables
  • Ensure no broken spacing or misaligned columns.


5. Separate Conceptual vs Operational Content

Split README into:

  • What it is (overview, purpose)
  • How to use it (installation, usage)
  • How to contribute (guidelines, PR rules)

This reduces cognitive load.


6. Enhance Checklist Clarity

Your checklist is strong but can be improved by:

  • Grouping logically:

    • Setup checks
    • Code quality checks
    • Documentation checks
  • Marking required vs optional items


7. Add Visual Anchors (if applicable)

  • Add badges at top:

    • Build status
    • License
    • Python/Node version
  • Include GIFs/screenshots for:

    • UI changes
    • Agent behavior examples

8. Improve Consistency of Terminology

  • Use consistent naming:

    • “agent” vs “Agent”
    • “README.md” vs “readme”
  • Keep capitalization uniform across sections.


9. Add “Common Issues / Troubleshooting” Section

Highly recommended if not present:

  • Installation failures
  • Environment variable issues
  • Dependency conflicts

10. Keep Contribution Rules Prominent

  • Move critical rules (like directory structure and linting commands) closer to top of CONTRIBUTING/README section.

  • Ensure contributors don’t miss:

    • ruff check .
    • folder placement rules

11. Reduce Redundancy

  • Avoid repeating:

    • Setup instructions in multiple places
    • Same checklist items in different formats

Add notes for improving README formatting and structure.
@Dippp10-ally
Copy link
Copy Markdown
Author

@gautammanak1 ji , do assign labels called as gssoc:approved , level:intermediate , type:docs , quality:exceptional to above pull request number 147 also....do merge above pull request number 147 also....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant