Skip to content

Commit dfa4c98

Browse files
committed
docs: fix mkdocs build warnings and API reference module paths
1 parent 6ba9637 commit dfa4c98

9 files changed

Lines changed: 126 additions & 13 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# <center> ContextCraft Code of Conduct: The Art of Awesome Collaboration</center>
2+
3+
Welcome to ContextCraft! We're thrilled you're here and excited to see what amazing things we can build together. To ensure our community is a fantastic place for everyone, we've put together a few guidelines. Think of them less as "rules" and more as "recipes for a delicious collaboration stew."
4+
5+
## Our Pledge: Crafting a Great Experience
6+
7+
In the interest of fostering an open, welcoming, and frankly, rather brilliant environment, we as contributors and maintainers pledge to make participation in our project and community a harassment-free experience for everyone. We don't care about your age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. We *do* care about you being awesome to others.
8+
9+
We aim for a community where:
10+
* **Curiosity is King (or Queen, or Esteemed Non-Binary Monarch):** Ask questions! Explore ideas! We're all learning.
11+
* **Kindness is Cacheable:** Once you're kind, it tends to stick around and make everything run smoother.
12+
* **Feedback is a Feature, Not a Bug:** Constructive criticism, offered politely, helps us all improve.
13+
* **Wit is Welcome, Wisecracks are Weighed:** A bit of humor can lighten the load, but let's ensure it doesn't come at someone else's expense.
14+
15+
## Our Standards: The Ingredients for Awesome
16+
17+
Examples of behavior that contributes to a positive environment include:
18+
19+
* **Using welcoming and inclusive language:** "Hey folks!" beats "Listen up, n00bs!" every time.
20+
* **Being respectful of differing viewpoints and experiences:** We might not always agree on the best way to sort a list, but we can still be friends.
21+
* **Gracefully accepting constructive criticism:** "Oh, good point, I hadn't thought of that!" is a sign of strength.
22+
* **Focusing on what is best for the community and the project:** Sometimes your brilliant idea for a blinking text feature needs to take a backseat to accessibility.
23+
* **Showing empathy towards other community members:** Remember, there's a human on the other side of that screen, possibly fueled by too much coffee or too little sleep.
24+
* **Sharing your amazing cat photos (optional, but highly encouraged in appropriate channels).**
25+
26+
Examples of unacceptable behavior by participants include:
27+
28+
* **The use of sexualized language or imagery and unwelcome sexual attention or advances:** Keep it classy, folks.
29+
* **Trolling, an-cap trolling, insulting/derogatory comments, and personal or political attacks:** If your comment wouldn't make your grandma proud, maybe rethink it.
30+
* **Public or private harassment:** Seriously, just don't.
31+
* **Publishing others' private information, such as a physical or electronic address, without explicit permission:** That's not cool, it's creepy.
32+
* **Other conduct which could reasonably be considered inappropriate in a professional setting (even if our "setting" is a GitHub issue tracker at 3 AM).**
33+
* **Arguing about spaces vs. tabs with the intent to start a flame war.** (Okay, maybe a little lighthearted debate is fine, but you get the idea.)
34+
35+
## Our Responsibilities: Keeping the Stew from Spoiling
36+
37+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. We're not looking to be a D&D dungeon master on a power trip, but we will keep things tidy.
38+
39+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. This will always be done with as much transparency as is reasonable.
40+
41+
## Scope: Where Does This Culinary Code Apply?
42+
43+
This Code of Conduct applies within all project spaces (GitHub repository, issue tracker, pull requests, any official communication channels like Slack or Discord if they exist), and it also applies when an individual is representing the project or its community in public spaces. Representing ContextCraft might mean using an official project email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Let's make ContextCraft look good everywhere!
44+
45+
## Enforcement: When the Soufflé Falls Flat
46+
47+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [INSERT YOUR PREFERRED CONTACT METHOD HERE - e.g., a dedicated email like conduct@contextcraft.dev, or a link to privately message a maintainer]. Please don't use the public issue tracker for CoC reports.
48+
49+
All complaints will be reviewed and investigated promptly and fairly. We respect the privacy and security of the reporter of any incident.
50+
51+
Possible enforcement actions include:
52+
* A polite, private correction.
53+
* A public warning (if the behavior was public and mild).
54+
* Temporary or permanent ban from project spaces.
55+
* A strongly worded haiku about the importance of being excellent to each other.
56+
57+
## Attribution: Giving Credit Where It's Due
58+
59+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1], and inspired by numerous other open-source codes of conduct that aim for a bit of personality. We also threw in a dash of our own flavor.
60+
61+
[homepage]: https://www.contributor-covenant.org
62+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
63+
64+
---
65+
66+
Remember to replace `[INSERT YOUR PREFERRED CONTACT METHOD HERE]` with how you want people to report issues.
67+
68+
This CoC tries to be:
69+
* **Clear:** States expectations directly.
70+
* **Inclusive:** Emphasizes welcoming everyone.
71+
* **Actionable:** Describes enforcement.
72+
* **Slightly Witty/Approachable:** Uses analogies and a bit of humor to make it less dry, hopefully encouraging people to actually read it.
73+
* **Standard-Based:** Attributes its source to the well-respected Contributor Covenant.
74+
75+
Let me know what you think!

docs/development/contributing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Thank you for your interest in contributing to ContextCraft! We welcome contribu
1818

1919
## 📜 Code of Conduct
2020

21-
This project and everyone participating in it is governed by our [Code of Conduct](../../CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.
21+
This project and everyone participating in it is governed by our [Code of Conduct](https://github.com/Shorzinator/ContextCraft/blob/main/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.
2222

2323
## 🚀 Getting Started
2424

@@ -78,7 +78,7 @@ Before creating a bug report, please check the [existing issues](https://github.
7878

7979
### Bug Report Template
8080

81-
When reporting bugs, please use our [issue template](../../.github/ISSUE_TEMPLATE.md) and include:
81+
When reporting bugs, please use our [issue template](https://github.com/Shorzinator/ContextCraft/blob/main/.github/ISSUE_TEMPLATE.md) and include:
8282

8383
- **Clear Description**: What happened vs. what you expected
8484
- **Reproduction Steps**: Detailed steps to reproduce the issue
@@ -279,7 +279,7 @@ poetry run pytest -k "test_tree"
279279

280280
### PR Template
281281

282-
We provide a [PR template](../../.github/PULL_REQUEST_TEMPLATE.md) that includes:
282+
We provide a [PR template](https://github.com/Shorzinator/ContextCraft/blob/main/.github/PULL_REQUEST_TEMPLATE.md) that includes:
283283

284284
- Description of changes
285285
- Type of change (bug fix, feature, etc.)
@@ -317,7 +317,7 @@ We provide a [PR template](../../.github/PULL_REQUEST_TEMPLATE.md) that includes
317317

318318
- **GitHub Issues**: For bugs and feature requests
319319
- **GitHub Discussions**: For questions and general discussion
320-
- **Documentation**: Check our [comprehensive docs](../../docs/)
320+
- **Documentation**: Check our [comprehensive docs](../index.md)
321321

322322
### Maintainer Contact
323323

docs/reference/config_manager.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Config Manager
2+
3+
::: contextcraft.utils.config_manager
4+
5+
The config manager module provides configuration management functionality for ContextCraft, handling default settings and user-defined configurations.
6+
7+
## Overview
8+
9+
The config manager is responsible for:
10+
11+
- Loading and managing configuration files
12+
- Providing default configuration values
13+
- Handling configuration validation
14+
- Managing configuration overrides
15+
16+
## Configuration Files
17+
18+
ContextCraft supports configuration through:
19+
20+
- Project-level configuration files
21+
- User-level configuration files
22+
- Environment variable overrides
23+
- Command-line argument overrides
24+
25+
## Default Configuration
26+
27+
The config manager provides sensible defaults for all configuration options, ensuring that ContextCraft works out of the box without requiring extensive configuration.
28+
29+
## Related Modules
30+
31+
- [`bundler`](tools/bundler.md): Uses configuration for bundle settings
32+
- [`git_provider`](tools/git_provider.md): Uses configuration for Git-related settings

docs/reference/flattener.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This module contains the logic for flattening code and text files from a directory.
44

5-
::: src.contextcraft.tools.flattener
5+
::: contextcraft.tools.flattener
66
handler: python
77
options:
88
show_root_heading: true

docs/reference/main.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This section provides an API reference for the main CLI application and its commands, generated from the source code docstrings.
44

5-
::: src.contextcraft.main.app
5+
::: contextcraft.main
66
handler: python
77
options:
88
show_root_heading: true

docs/reference/tools/dependency_lister.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
# Dependency Lister (`contextcraft.tools.dependency_lister`)
1+
# Dependency Lister API Reference
22

3-
This module provides comprehensive dependency analysis capabilities for multi-language projects.
4-
5-
::: src.contextcraft.tools.dependency_lister
3+
::: contextcraft.tools.dependency_lister
64
handler: python
75
options:
86
show_root_heading: true

docs/reference/tree_generator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This module provides the core logic for generating directory tree structures.
44

5-
::: src.contextcraft.tools.tree_generator
5+
::: contextcraft.tools.tree_generator
66
handler: python
77
options:
88
show_root_heading: true

docs/user-guide/cli-commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ Output includes:
215215
# Python content here...
216216
```
217217

218-
## 📦 deps - Dependency Analysis
218+
## 📦 deps - Dependency Analysis {#deps-command}
219219

220220
Analyze and document project dependencies across multiple languages.
221221

mkdocs.yml

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ plugins:
141141
default_handler: python
142142
handlers:
143143
python:
144+
paths: [src]
144145
options:
145146
docstring_style: google
146147
docstring_options:
@@ -202,11 +203,18 @@ nav:
202203
- Main CLI: reference/main.md
203204
- Tree Generator: reference/tree_generator.md
204205
- Flattener: reference/flattener.md
205-
- Dependency Lister: reference/tools/dependency_lister.md
206+
- Config Manager: reference/config_manager.md
207+
- Tools:
208+
- Dependency Lister: reference/tools/dependency_lister.md
209+
- Bundler: reference/tools/bundler.md
210+
- Git Provider: reference/tools/git_provider.md
206211
- Examples:
207212
- Python Projects: examples/python-projects.md
213+
- Bundle Workflows: examples/bundle-workflows.md
214+
- Git Workflows: examples/git-workflows.md
208215
- Development:
209216
- Contributing: development/contributing.md
217+
- Infrastructure: development/infrastructure.md
210218
- Help:
211219
- FAQ: help/faq.md
212220
- Troubleshooting: help/troubleshooting.md

0 commit comments

Comments
 (0)