Skip to content

docs(#198): sync README and RTD index content for AboutCode overview and TOC #205

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

satyajeetch1991
Copy link

Summary

This PR addresses issue #198 by updating and synchronizing the "What is AboutCode?" and "Projects" sections across the GitHub README.md and ReadTheDocs index.rst. It ensures users see consistent and accurate documentation in both locations.

Changes Made

  • 🔁 Revised the README with improved explanation and cleaned project listings
  • 🧭 Updated docs/index.rst to mirror README overview and TOC structure
  • 🤖 Added .github/workflows/sync-readme-to-rst.yml GitHub Action to automate Markdown to reStructuredText syncing (if needed in future)
  • 🧪 Verified Sphinx builds and doc8 styling checks pass locally

Fixes

Fixes #198


✅ Checklist

  • PR is descriptively titled 📑 and links the original issue above 🔗
  • Tests pass (Sphinx build + doc8 style check) ✔️
  • Commits are in a uniquely-named feature branch and have no merge conflicts 📁
  • Added GitHub Action workflow file for syncing future README updates if required

If any CI tests fail, click the ❌ icon to expand the logs and identify the problem. Most failures are either doc8 formatting issues or Sphinx warnings. Feel free to ask for help if needed.


🔏 Sign-Off

Contributed by @satyajeetch1991 as part of improving project documentation consistency.

- Updated 'What is AboutCode?' and 'Projects' sections in README.md
- Reflected the same updates in docs/index.rst to ensure consistency
- Added GitHub Action to auto-sync README to RTD using rst format
- Fulfills the proposal in issue aboutcode-org#198 for improving AboutCode TOC documentation

Signed-off-by: Satyajeet Chavan <[email protected]>
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.

Update AboutCode "TOC" information in README and RTD
1 participant