Skip to content

Commit dd5ccc3

Browse files
committed
Update TUI and Docs
1 parent 548ab1b commit dd5ccc3

41 files changed

Lines changed: 1431 additions & 288 deletions

Some content is hidden

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

.editorconfig

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
root = true
2+
3+
[*.py]
4+
charset = utf-8
5+
indent_style = space
6+
indent_size = 4
7+
end_of_line = lf
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true
10+
11+
[*.{md,yml,yaml,toml}]
12+
charset = utf-8
13+
indent_style = space
14+
indent_size = 2
15+
end_of_line = lf
16+
insert_final_newline = true
17+
trim_trailing_whitespace = true
18+
19+
[Makefile]
20+
indent_style = tab

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ body:
6464
description: Please provide your environment details.
6565
value: |
6666
- OS: [e.g., Ubuntu 22.04, macOS 14.0, Windows 11]
67-
- Python version: [e.g., 3.10.5]
68-
- DSPy Code version: [e.g., 0.1.0]
69-
- DSPy version: [e.g., 3.0.4]
67+
- Python version: [e.g., 3.11.9]
68+
- RLM Code version: [e.g., 0.1.5]
69+
- DSPy version (if relevant): [e.g., 3.0.4]
7070
- Installation method: [e.g., pip, uv, source]
7171
validations:
7272
required: true
@@ -87,5 +87,5 @@ body:
8787
required: true
8888
- label: I have provided all requested information
8989
required: true
90-
- label: I am using the latest version of DSPy Code
90+
- label: I am using the latest version of RLM Code
9191
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
blank_issues_enabled: false
22
contact_links:
33
- name: 📚 Documentation
4-
url: https://superagenticai.github.io/dspy-code/
4+
url: https://superagenticai.github.io/rlm-code/
55
about: Read the full documentation

.github/ISSUE_TEMPLATE/documentation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ body:
3030
attributes:
3131
label: Documentation Location
3232
description: Where is the documentation issue? (URL or file path)
33-
placeholder: https://superagenticai.github.io/dspy-code/guide/...
33+
placeholder: https://superagenticai.github.io/rlm-code/...
3434
validations:
3535
required: true
3636

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ body:
5353
render: python
5454
placeholder: |
5555
# Example code or command
56-
dspy-code /new-command
56+
rlm-code /new-command
5757
5858
- type: dropdown
5959
id: priority

.github/SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,4 @@ Security updates will be released as patch versions (e.g., 0.1.1 → 0.1.2) and
4949
* Review dependencies for known vulnerabilities
5050
* Keep dependencies up to date
5151

52-
Thank you for helping keep DSPy Code secure! 🔒
52+
Thank you for helping keep RLM Code secure! 🔒

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,4 @@ pytest tests/
7878
By submitting this PR, I confirm that:
7979
- [ ] I have read the [Contributing Guide](../CONTRIBUTING.md)
8080
- [ ] My contribution is original or properly attributed
81-
- [ ] I agree to license my contribution under the MIT License
81+
- [ ] I agree to license my contribution under the Apache-2.0 License

.github/workflows/deploy-docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
run: uv sync --locked --extra docs
3434

3535
- name: Build and deploy documentation
36-
run: uv run mkdocs gh-deploy --force --clean --verbose
36+
run: uv run mkdocs gh-deploy --force --clean --verbose --remote-branch gh-pages
3737
env:
3838
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
3939

AI-GENERATED-CODE-POLICY.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# AI-Generated Code Policy
2+
3+
AI-assisted contributions are allowed.
4+
5+
## Requirements
6+
7+
1. Disclose AI usage in the PR description.
8+
2. Name the tool/model used and what it produced.
9+
3. Verify correctness, security, and licensing before submission.
10+
4. Add or update tests for any behavior change.
11+
5. Keep generated content consistent with project style and docs.
12+
13+
## Responsibility
14+
15+
Contributors remain fully responsible for all submitted code, including AI-generated code.
16+
17+
## Prohibited
18+
19+
- Submitting code you do not understand.
20+
- Copying proprietary or unlicensed content.
21+
- Committing secrets or credentials.

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Before creating bug reports, please check the [issue tracker](https://github.com
1616
* Exact steps to reproduce the problem
1717
* Expected vs actual behavior
1818
* Screenshots (if applicable)
19-
* Environment details (OS, Python version, DSPy version)
19+
* Environment details (OS, Python version, RLM Code version)
2020

2121
### Suggesting Enhancements
2222

@@ -39,7 +39,7 @@ See [AI-GENERATED-CODE-POLICY.md](AI-GENERATED-CODE-POLICY.md) for our rules abo
3939

4040
### Prerequisites
4141

42-
* Python 3.10 or higher (we support Python 3.10, 3.11, 3.12, and 3.13)
42+
* Python 3.11 or higher (we support Python 3.11, 3.12, and 3.13)
4343
* [uv](https://github.com/astral-sh/uv) (recommended) or pip
4444
* Git
4545

@@ -166,7 +166,7 @@ Then create a pull request on GitHub.
166166

167167
**CI/CD Expectations:**
168168
* All PRs must pass CI checks (linting, formatting, tests)
169-
* Tests must pass on all supported Python versions (3.10, 3.11, 3.12, 3.13)
169+
* Tests must pass on all supported Python versions (3.11, 3.12, 3.13)
170170
* Code must pass Ruff linting and formatting checks
171171
* Coverage should not decrease significantly
172172
* Fix any CI failures before requesting review
@@ -398,15 +398,15 @@ Instead, please report them via email to **team@super-agentic.ai** with:
398398

399399
We will acknowledge receipt within 48 hours and provide a timeline for addressing the issue.
400400

401-
For more details, see our [Security documentation](https://superagenticai.github.io/rlm-code/reference/security/).
401+
For more details, see our [Security documentation](https://superagenticai.github.io/rlm-code/security/).
402402

403403
## Dependency Management
404404

405405
* We use `uv` (recommended) or `pip` for dependency management
406406
* Dependencies are managed in `pyproject.toml`
407407
* When adding new dependencies:
408408
* Justify why it's needed
409-
* Check for license compatibility (MIT-compatible preferred)
409+
* Check for license compatibility (Apache-2.0-compatible preferred)
410410
* Consider the dependency's maintenance status
411411
* Update version constraints appropriately
412412
* Security updates are handled via Dependabot
@@ -453,7 +453,7 @@ All contributors are recognized in:
453453

454454
## License
455455

456-
By contributing, you agree that your contributions will be licensed under the MIT License.
456+
By contributing, you agree that your contributions will be licensed under the Apache-2.0 License.
457457

458458
---
459459

0 commit comments

Comments
 (0)