-
-
Notifications
You must be signed in to change notification settings - Fork 9
Improve readme documentation #100
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
Closed
Sahil-u07
wants to merge
2
commits into
aboutcode-org:main
from
Sahil-u07:improve-readme-documentation
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,4 +1,371 @@ | ||||||
| # www.aboutcode.org | ||||||
| Repository for the AboutCode public website - based on Docusaurus. | ||||||
| # AboutCode.org Website | ||||||
|
|
||||||
| <div align="center"> | ||||||
|
|
||||||
| [](https://github.com/aboutcode-org/www.aboutcode.org/actions/workflows/deploy.yml) | ||||||
| [](https://opensource.org/licenses/Apache-2.0) | ||||||
| [](https://docusaurus.io/) | ||||||
| [](https://nodejs.org/) | ||||||
|
|
||||||
| **Official documentation and community website for the AboutCode project** | ||||||
|
|
||||||
| [Live Website](https://aboutcode-org.github.io/www.aboutcode.org/) • [Report Bug](https://github.com/aboutcode-org/www.aboutcode.org/issues) • [Request Feature](https://github.com/aboutcode-org/www.aboutcode.org/issues) | ||||||
|
|
||||||
| </div> | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## 📋 Table of Contents | ||||||
|
|
||||||
| - [About](#about) | ||||||
| - [Key Features](#key-features) | ||||||
| - [Prerequisites](#prerequisites) | ||||||
| - [Getting Started](#getting-started) | ||||||
| - [Development](#development) | ||||||
| - [Project Structure](#project-structure) | ||||||
| - [Contributing](#contributing) | ||||||
| - [Community & Support](#community--support) | ||||||
| - [Technology Stack](#technology-stack) | ||||||
| - [Deployment](#deployment) | ||||||
| - [Troubleshooting](#troubleshooting) | ||||||
| - [License](#license) | ||||||
|
|
||||||
| ## 🌟 About | ||||||
|
|
||||||
| AboutCode is a community of open source developers dedicated to creating tools that help organizations discover, analyze, and manage open source software dependencies. This repository contains the source code for the AboutCode website, built using Docusaurus - a modern static website generator. | ||||||
|
|
||||||
| ### AboutCode Projects | ||||||
|
|
||||||
| - **[ScanCode Toolkit](https://github.com/aboutcode-org/scancode-toolkit)** - Comprehensive license, copyright, and dependency scanner | ||||||
| - **[VulnerableCode](https://github.com/aboutcode-org/vulnerablecode)** - Free and open vulnerability database | ||||||
| - **[PURL-DB](https://github.com/aboutcode-org/purldb)** - Package URL database for universal software package identification | ||||||
| - **[DejaCode](https://github.com/aboutcode-org/dejacode)** - Enterprise-grade application for managing open source compliance | ||||||
|
|
||||||
| ## ✨ Key Features | ||||||
|
|
||||||
| - 📚 **Comprehensive Documentation** - Detailed guides for all AboutCode projects | ||||||
| - 📝 **Community Blog** - Latest news, updates, and community contributions | ||||||
| - 🎨 **Modern UI** - Clean, responsive design built with React | ||||||
| - 🔍 **Search Functionality** - Quick access to documentation and resources | ||||||
| - 🌐 **Multi-language Support** - Internationalization ready | ||||||
| - ♿ **Accessibility** - WCAG compliant | ||||||
| - 📱 **Mobile Responsive** - Optimized for all devices | ||||||
|
|
||||||
| ## 📦 Prerequisites | ||||||
|
|
||||||
| Before you begin, ensure you have the following installed: | ||||||
|
|
||||||
| - **Node.js** `>= 20.0` ([Download](https://nodejs.org/)) | ||||||
| - **npm** `>= 9.0` (comes bundled with Node.js) | ||||||
| - **Git** ([Download](https://git-scm.com/)) | ||||||
|
|
||||||
| ## 🚀 Getting Started | ||||||
|
|
||||||
| ### Installation | ||||||
|
|
||||||
| 1. **Clone the repository** | ||||||
|
|
||||||
| ```bash | ||||||
| git clone https://github.com/aboutcode-org/www.aboutcode.org.git | ||||||
| cd www.aboutcode.org | ||||||
| ``` | ||||||
|
|
||||||
| 2. **Navigate to the website directory** | ||||||
|
|
||||||
| ```bash | ||||||
| cd website | ||||||
| ``` | ||||||
|
|
||||||
| 3. **Install dependencies** | ||||||
|
|
||||||
| ```bash | ||||||
| npm install | ||||||
| ``` | ||||||
|
|
||||||
| 4. **Start the development server** | ||||||
|
|
||||||
| ```bash | ||||||
| npm start | ||||||
| ``` | ||||||
|
|
||||||
| The website will automatically open at `http://localhost:3000/www.aboutcode.org/` | ||||||
|
|
||||||
| ## 💻 Development | ||||||
|
|
||||||
| ### Available Commands | ||||||
|
|
||||||
| All commands should be run from the `website` directory: | ||||||
|
|
||||||
| | Command | Description | | ||||||
| |---------|-------------| | ||||||
| | `npm start` | Start development server with hot reload | | ||||||
| | `npm run build` | Build production-ready static files | | ||||||
| | `npm run serve` | Preview production build locally | | ||||||
| | `npm run clear` | Clear Docusaurus cache | | ||||||
| | `npm run deploy` | Deploy to GitHub Pages | | ||||||
| | `npm run swizzle` | Customize Docusaurus components | | ||||||
|
|
||||||
| ### Local Development Workflow | ||||||
|
|
||||||
| 1. Create a new branch for your changes: | ||||||
| ```bash | ||||||
| git checkout -b feature/your-feature-name | ||||||
| ``` | ||||||
|
|
||||||
| 2. Make your changes in the `website` directory | ||||||
|
|
||||||
| 3. Test your changes locally: | ||||||
| ```bash | ||||||
| npm start | ||||||
| ``` | ||||||
|
|
||||||
| 4. Build to ensure no errors: | ||||||
| ```bash | ||||||
| npm run build | ||||||
| ``` | ||||||
|
|
||||||
| 5. Commit your changes with a descriptive message: | ||||||
| ```bash | ||||||
| git commit -m "Add: brief description of changes" | ||||||
| ``` | ||||||
|
|
||||||
| ### Hot Reload | ||||||
|
|
||||||
| The development server includes hot module replacement. Changes to React components, pages, and styles will automatically refresh in the browser without losing state. | ||||||
|
|
||||||
| ## 📁 Project Structure | ||||||
|
|
||||||
| ``` | ||||||
| . | ||||||
| ├── .github/ | ||||||
| │ └── workflows/ # GitHub Actions CI/CD workflows | ||||||
| │ ├── deploy.yml # Deployment workflow | ||||||
| │ └── ci.yml # Continuous integration | ||||||
| ├── website/ | ||||||
| │ ├── blog/ # Blog posts (MDX format) | ||||||
| │ │ ├── authors.yml # Blog author information | ||||||
| │ │ └── tags.yml # Blog tag definitions | ||||||
| │ ├── docs/ # Documentation pages | ||||||
| │ │ ├── about/ # About section | ||||||
| │ │ ├── getting_started/ # Getting started guides | ||||||
| │ │ └── tutorial-basics/ # Basic tutorials | ||||||
| │ ├── src/ | ||||||
| │ │ ├── components/ # React components | ||||||
| │ │ │ ├── HomepageContent/ | ||||||
| │ │ │ ├── HomepageFeatures/ | ||||||
| │ │ │ └── ProjectGridTemplate/ | ||||||
| │ │ ├── css/ # Global styles | ||||||
| │ │ ├── data/ # Project data (JSON) | ||||||
| │ │ └── pages/ # Custom pages (React) | ||||||
| │ ├── static/ # Static assets (images, fonts) | ||||||
| │ │ └── img/ # Images | ||||||
| │ ├── docusaurus.config.js # Docusaurus configuration | ||||||
| │ ├── sidebars.js # Sidebar navigation | ||||||
| │ ├── package.json # Dependencies and scripts | ||||||
| │ └── README.md # Website-specific documentation | ||||||
| ├── README.md # This file | ||||||
| └── LICENSE # License information | ||||||
|
||||||
| └── LICENSE # License information |
Copilot
AI
Jan 18, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Technology Stack section states Docusaurus v3.x, but package.json shows the exact version is 3.9.2. For consistency and accuracy with the rest of the section which shows specific version ranges, this should be updated to reflect the actual version constraint.
Suggested change
| - **[Docusaurus](https://docusaurus.io/)** `v3.x` - Static site generator | |
| - **[Docusaurus](https://docusaurus.io/)** `v3.9.2` - Static site generator |
Copilot
AI
Jan 18, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documentation references a LICENSE file with a link that will be broken since the LICENSE file does not exist in the repository. This needs to be corrected.
Suggested change
| This project documentation is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details. | |
| This project documentation is licensed under the [Apache License 2.0](https://opensource.org/licenses/Apache-2.0). |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The project structure references a ci.yml file that does not exist in the .github/workflows directory. Only deploy.yml exists. This file reference should be removed to avoid confusion.