Skip to content

Commit dc11210

Browse files
committed
cleanup errors and reorg nav
1 parent 794d4b7 commit dc11210

43 files changed

Lines changed: 1014 additions & 59 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/concepts/_category_.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
position: 2
1+
position: 3
22
label: Concepts
33
collapsed: false
44
link:

docs/concepts/ai_and_llms.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar_position: 24
3+
---
4+
15
# AI and LLMs in Programming
26

37
**Large Language Models (LLMs)** have rapidly changed how software is written. Tools like GitHub Copilot, ChatGPT, Claude, and Cursor can generate code, explain errors, write tests, and review pull requests. Understanding what these tools are, how they work, and how to use them responsibly is increasingly important for any programmer.

docs/concepts/apis.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar_position: 8
3+
---
4+
15
# APIs
26

37
An **API** (Application Programming Interface) is a defined way for two pieces of software to communicate with each other. APIs are everywhere in modern software: when a weather app shows you the forecast, it's fetching data from a weather API. When you log into a site with Google, that site is calling Google's OAuth API.

docs/concepts/ci_cd.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar_position: 9
3+
---
4+
15
# CI/CD
26

37
**CI/CD** stands for **Continuous Integration** and **Continuous Delivery** (or Deployment). It's a set of practices and tools that automate the testing and deployment of software, letting teams ship code more reliably and frequently.

docs/concepts/collaboration_and_communication.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar_position: 10
3+
---
4+
15
# Collaboration and Communication
26

37
Collaboration and communication are at the heart of open source development. Open source projects thrive on the contributions of a diverse and often geographically dispersed community of developers, designers, testers, and users. Effective collaboration and clear communication are key to the success of these projects. In this guide, we'll explore how collaboration and communication work in the open source ecosystem.

docs/concepts/command_line.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
15
# Command Line
26

37
The command line (also called the **terminal**, **shell**, or **CLI** — Command Line Interface) is a text-based way to interact with your computer. Instead of clicking icons and menus, you type commands.

docs/concepts/community.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar_position: 17
3+
---
4+
15
# Community
26

37
The open source community is diverse and highly motivated. Whether it’s development or advocacy, open source software and other collaborative projects benefit through, and because of, community.
@@ -35,7 +39,8 @@ The role of an open source community architect involves a variety of tasks and r
3539
- Developing strategies to grow and engage the community
3640
- Monitoring and measuring the health and success of the community
3741

38-
## Links
39-
https://opensource.org/community
42+
## References
43+
44+
- [Open Source Initiative: Community](https://opensource.org/community)
4045

4146

docs/concepts/debugging.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar_position: 4
3+
---
4+
15
# Debugging
26

37
Debugging is the process of finding and fixing errors (bugs) in your code. Every programmer spends a significant portion of their time debugging — it's a core skill, not a sign of failure.

docs/concepts/documentation.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar_position: 6
3+
---
4+
15
# Documentation
26

37
Documentation is any communicable material that is used to describe, explain or instruct regarding some attributes of an object, system or procedure, such as its parts, assembly, installation, maintenance and use.
@@ -47,6 +51,10 @@ To write good open source documentation, there are a few key things you should k
4751
- Keep it up to date: As the project evolves, make sure to update the documentation to reflect any changes or new features. This will ensure that the documentation stays relevant and accurate.
4852
- Get feedback: Ask other contributors or users to review the documentation and provide feedback. This can help identify any gaps or areas that need clarification.
4953

54+
## See Also
55+
56+
- [Open Source Projects](/concepts/projects) — how to write a good README and CONTRIBUTING file for your project
57+
5058
## References
5159
- [The Documentation System](https://documentation.divio.com/)
5260
- [Wikipedia's documentation page](https://en.wikipedia.org/wiki/Documentation)

docs/concepts/engineering_methodologies.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar_position: 14
3+
---
4+
15
# Engineering Methodologies
26

37
Engineering methodologies are structured approaches to planning, executing, and managing engineering projects. They provide a systematic framework for designing, developing, and maintaining complex systems, products, or processes. By following established engineering methodologies, teams can ensure efficiency, quality, and successful project outcomes. Here, we explore some commonly used engineering methodologies:
@@ -65,7 +69,7 @@ RAD is an approach that prioritizes rapid prototyping and quick iterations. It a
6569
The Spiral model is a risk-driven methodology that combines iterative development with elements of the Waterfall model. It involves cycles of planning, risk analysis, engineering, and evaluation. Each iteration addresses potential risks, making it suitable for large and complex projects.
6670

6771
- [ArtofTesting: Spiral Model](https://artoftesting.com/spiral-model)
68-
- [Broken Link](https://www.spaceo.ca/blog/spiral-model-of-software-development/)
72+
- [Spaceo: Spiral Model of Software Development](https://www.spaceo.ca/blog/spiral-model-of-software-development/)
6973

7074
## Six Sigma
7175

0 commit comments

Comments
 (0)