Skip to content

Feature/docs #13

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Nov 9, 2024
Merged

Feature/docs #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
41f8aac
docs: update README to improve navigation and accessibility of topic …
brandoniscoding-dev Nov 9, 2024
db5ff11
Merge remote-tracking branch 'origin/master' into feature/docs
brandoniscoding-dev Nov 9, 2024
d8de3e1
docs: move CONTRIBUTING.md to .github folder and update README link
brandoniscoding-dev Nov 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 2 additions & 18 deletions CONTRIBUTING.md → .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,6 @@ java_programming/
│ │ ├── InsertionSort.java
│ │ ├── QuickSort.java
│ │ └── Main.java
│ ├── docs/
│ │ ├── README.md
│ │ └── CONTRIBUTING.md
│ ├── tests/
│ │ └── SortTest.java
│ └── utils/
Expand All @@ -40,9 +37,6 @@ java_programming/
│ ├── src/
│ │ ├── Search.java
│ │ └── Add.java
│ ├── docs/
│ │ ├── README.md
│ │ └── CONTRIBUTING.md
│ ├── tests/
│ │ └── TreeTest.java
│ └── utils/
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand Down
26 changes: 4 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,29 +56,15 @@ You will find sorting algorithms, data structures such as trees, queues, stacks,

## Table of Contents

<details>
<summary><strong>Arrays</strong></summary>
<p>Details about Arrays.</p>
<!-- Include relevant content or links here -->
</details>

<details>
<summary><strong>Sorts</strong></summary>
<p>Details about sorting algorithms.</p>
<!-- Include relevant content or links here -->
</details>

<details>
<summary><strong>Trees</strong></summary>
<p>Details about tree data structures.</p>
<!-- Include relevant content or links here -->
For more information about sorting algorithms, refer to the [README file in the 'sorts' folder](sorts/README.md).
</details>

<details>
<summary><strong>Queues</strong></summary>
<p>Details about queue data structures.</p>
<!-- Include relevant content or links here -->
</details>



<details>
<summary><strong>Stacks</strong></summary>
Expand Down Expand Up @@ -121,14 +107,10 @@ Make sure you have installed the following before cloning the repository:
```bash
mvn test
```
6. Generate a documentation:
```bash
mvn javadoc:javadoc
```

## 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

Expand Down