From 41f8aac9ef9f8f4e5305efa7ee00923dbe9813d9 Mon Sep 17 00:00:00 2001 From: brandoniscoding Date: Sat, 9 Nov 2024 11:22:22 +0100 Subject: [PATCH 1/2] docs: update README to improve navigation and accessibility of topic details in the table of contents --- README.md | 24 +++--------------------- 1 file changed, 3 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 7dcdd71..211192c 100644 --- a/README.md +++ b/README.md @@ -56,29 +56,15 @@ You will find sorting algorithms, data structures such as trees, queues, stacks, ## Table of Contents -
- Arrays -

Details about Arrays.

- -
-
Sorts

Details about sorting algorithms.

- -
-
- Trees -

Details about tree data structures.

- + For more information about sorting algorithms, refer to the [README file in the 'sorts' folder](sorts/README.md).
-
- Queues -

Details about queue data structures.

- -
+ +
Stacks @@ -121,10 +107,6 @@ Make sure you have installed the following before cloning the repository: ```bash mvn test ``` -6. Generate a documentation: - ```bash - mvn javadoc:javadoc - ``` ## Contributing From d8de3e1c08242c5d56883e500c354f7b20f1eaef Mon Sep 17 00:00:00 2001 From: brandoniscoding Date: Sat, 9 Nov 2024 12:17:22 +0100 Subject: [PATCH 2/2] docs: move CONTRIBUTING.md to .github folder and update README link --- CONTRIBUTING.md => .github/CONTRIBUTING.md | 20 ++------------------ README.md | 2 +- 2 files changed, 3 insertions(+), 19 deletions(-) rename CONTRIBUTING.md => .github/CONTRIBUTING.md (85%) diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 85% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md index b694b86..924b364 100644 --- a/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -28,9 +28,6 @@ java_programming/ │ │ ├── InsertionSort.java │ │ ├── QuickSort.java │ │ └── Main.java -│ ├── docs/ -│ │ ├── README.md -│ │ └── CONTRIBUTING.md │ ├── tests/ │ │ └── SortTest.java │ └── utils/ @@ -40,9 +37,6 @@ java_programming/ │ ├── src/ │ │ ├── Search.java │ │ └── Add.java -│ ├── docs/ -│ │ ├── README.md -│ │ └── CONTRIBUTING.md │ ├── tests/ │ │ └── TreeTest.java │ └── utils/ @@ -64,12 +58,12 @@ Create a copy of the repository to your GitHub account by clicking the **"Fork"* Clone your fork locally to work on it: ```bash -git clone https://github.com/your_username/java_programming.git +git clone https://github.com/CamJSP-Community/java_programming.git ``` ### 3. Create a Branch for Your Changes -Create a new branch for your changes to keep the `main` branch clean: +Create a new branch for your changes to keep the `master` branch clean: ```bash git checkout -b your-branch-name @@ -111,16 +105,6 @@ Go to the original repository on GitHub and open a **Pull Request** from your br mvn test ``` -- **Documentation**: Use **Javadoc** to document your code. Here’s an example of how to generate documentation with Maven: - -```bash -mvn javadoc:javadoc -``` - -This command will generate documentation in the `target/site/apidocs/` folder. - ---- - ## License This project is licensed under the [MIT](./LICENSE) license. By contributing, you agree that your contribution will be under this license. diff --git a/README.md b/README.md index 211192c..ea3c42a 100644 --- a/README.md +++ b/README.md @@ -110,7 +110,7 @@ Make sure you have installed the following before cloning the repository: ## Contributing -We welcome contributions from the community! For more information, please refer to the [CONTRIBUTING.md](./CONTRIBUTING.md) file. +We welcome contributions from the community! For more information, please refer to the [CONTRIBUTING.md](./.github/CONTRIBUTING.md) file. ## License