Update readme doc - #275
Open
pavankumar730 wants to merge 67 commits into
Open
Conversation
Copy link
Copy Markdown
Sorry, something went wrong.
Add additional project descriptions and getting started items.
Signed-off-by: Michael Ehab Mikhail <michael.ehab@hotmail.com>
Signed-off-by: Michael Ehab Mikhail <michael.ehab@hotmail.com>
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
Fix failing RTD docs builds
Signed-off-by: Alok Kumar <alokkumarjipura9973@gmail.com>
Signed-off-by: Alok Kumar <alokkumarjipura9973@gmail.com>
Signed-off-by: Michael Ehab Mikhail <michael.ehab@hotmail.com>
Add GSoC 2025 Project Report
Add gsoc25 report - Alok Kumar
Gsoc 2025 final report
Add GSoC final report
Signed-off-by: Aayush Kumar <aayush214.kumar@gmail.com>
fix failing test cases in GSoC final report
Signed-off-by: Varsha U N <varshaun58@gmail.com>
Signed-off-by: Varsha U N <varshaun58@gmail.com>
Add GSoC 2025 Final report
Update README.md Project list
CRAVEX-Docs: Improve docs for Getting Started purposes aboutcode-org/www.aboutcode.org#49
- Created CONTRIBUTING.md with welcoming content for new contributors - Restructured README.md from 507 to 120 lines (76% reduction) - Converted verbose project descriptions to scannable table format - Added prominent Contributing section near the top - Organized projects into logical categories (Core Tools, Inspectors, Libraries, Other Tools) - Improved visual hierarchy with GitHub-style alerts - Maintained all essential information while improving readability - Verified documentation build succeeds This makes the README more beginner-friendly and less overwhelming for newcomers while preserving all project information in a more accessible format. Signed-off-by: Gyan Ranjan Panda <gyanranjanpanda@gmail.com>
…-readme-251 Restructure README.md for better readability and add CONTRIBUTING.md
Signed-off-by: Gyan Ranjan Panda <gyanranjanpanda@gmail.com>
…tton-link Fix sidebar home button link (Issue aboutcode-org#248)
The Edit on GitHub links were still pointing to the old nexB org. Changed it to aboutcode-org so the links go to the right place. Signed-off-by: Gyan Ranjan Panda <gyanranjanpanda@gmail.com>
…org-link Fix github_user in docs config
- Reduce excessive header sizes (H1: 2.2rem, H2: 1.8rem) - Improve dark mode link visibility with brighter blue - Add better sidebar navigation spacing - Reduce excessive list indentation Fixes aboutcode-org#258 Signed-off-by: Gyan Ranjan Panda <gyanranjanpanda@gmail.com>
…l-ui-fixes docs: fix critical UI issues in documentation
The RawGit CDN service (cdn.rawgit.com) has been permanently shut down, causing the AboutCode logo image to return a 404 error. This commit removes the broken image reference from the archived GSoC 2017 documentation page. Fixes aboutcode-org#231 Signed-off-by: Gyan Ranjan Panda <gyanranjanpanda@gmail.com>
Instead of just removing the broken logo, this commit adds the official AboutCode logo from the website. The logo is now stored locally in the repository at docs/source/_static/images/aboutcode_logo.svg and referenced using a relative path. This ensures the logo will always be available and won't break if external services go down. Fixes aboutcode-org#231 Signed-off-by: Gyan Ranjan Panda <gyanranjanpanda@gmail.com>
…logo-gsoc-2017 docs: remove broken logo link from GSoC 2017 page
- Increased top margin in .wy-nav-content from 0px to 20px for better spacing from navbar - Increased top padding in div.rst-content from 10px to 30px for improved text visibility - Added line-height: 1.6 for better text readability on desktop - Improved mobile responsive padding from 0px to 20px with line-height: 1.5 - Ensures content is not cramped against navigation elements Fixes aboutcode-org#235 Signed-off-by: Gyan Ranjan Panda <gyanranjanpanda@gmail.com>
Renamed apache-2.0.LICENSE to LICENSE so GitHub can properly recognize and display the Apache 2.0 license in the repository 'About' section and API responses. Fixes aboutcode-org#194 Signed-off-by: Gyan Ranjan Panda <gyanranjanpanda@gmail.com>
…ing-navbar-spacing fix: improve UI padding and text alignment between navbar and content
…-file-recognition-194 fix: rename project license file for GitHub recognition
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
9 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves the README structure and formatting for better clarity and readability.
Changes
This is my first contribution. Please let me know if any changes are required.