Skip to content

Commit ac9deba

Browse files
committed
Replaced Context Generator with CTX
1 parent 6f36f97 commit ac9deba

21 files changed

+88
-60
lines changed

docs/.vitepress/config.mts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ import {withMermaid} from "vitepress-plugin-mermaid";
33

44
export default withMermaid({
55
ignoreDeadLinks: true,
6-
title: "Context Generator Docs",
7-
description: "Documentation for Context Generator for LLM",
6+
title: "CTX Docs",
7+
description: "Documentation for CTX",
88
themeConfig: {
99
// https://vitepress.dev/reference/default-theme-config
1010
search: {
@@ -77,7 +77,7 @@ export default withMermaid({
7777
items: [
7878
{text: 'Instructions (Examples)', link: '/advanced/instructions'},
7979
{text: 'Development steps', link: '/advanced/development-steps'},
80-
{text: 'Development with Context Generator', link: '/advanced/development-process'},
80+
{text: 'Development with CTX', link: '/advanced/development-process'},
8181
{text: 'LLM Integration: Smart Context Requesting', link: '/advanced/smart-context-requesting'},
8282
],
8383
},

docs/advanced/development-process.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# How to Use Context Generator to Explore and Work with Any Codebase
1+
# How to Use **CTX** to Explore and Work with Any Codebase
22

3-
Context Generator is a powerful tool that can help you understand and navigate any codebase, making it easier to
4-
implement features, fix bugs, and contribute to projects. This guide shows you how to leverage Context Generator's
3+
**CTX** is a powerful tool that can help you understand and navigate any codebase, making it easier to
4+
implement features, fix bugs, and contribute to projects. This guide shows you how to leverage **CTX**'s
55
capabilities throughout your development workflow.
66

77
## Understanding a New Codebase
@@ -325,7 +325,7 @@ Share this with team members or AI assistants to get feedback on your implementa
325325
326326
### Pattern 3: Documentation Generation
327327
328-
Use Context Generator to create comprehensive documentation:
328+
Use **CTX** to create comprehensive documentation:
329329
330330
```yaml
331331
documents:
@@ -352,6 +352,6 @@ documents:
352352
6. **Create Implementation Plans**: Use gathered context to formulate clear implementation strategies
353353
7. **Share Context Efficiently**: Generate focused context documents to share with team members or AI assistants
354354

355-
By effectively using Context Generator to explore unfamiliar codebases, you can significantly reduce the time needed to
355+
By effectively using **CTX** to explore unfamiliar codebases, you can significantly reduce the time needed to
356356
understand complex systems, implement features more confidently, and solve bugs more efficiently. The tool transforms
357357
overwhelming code exploration into a structured, methodical process that builds comprehensive understanding.

docs/advanced/development-steps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -553,6 +553,6 @@ ctx --inline='{
553553
}'
554554
```
555555

556-
These examples illustrate how to use Context Generator effectively at each stage of the development workflow. The
556+
These examples illustrate how to use **CTX** effectively at each stage of the development workflow. The
557557
combination of inline ctx commands and clear instructions for AI assistants creates a powerful methodology for managing
558558
complex development tasks with appropriate context.

docs/advanced/instructions.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Instructions
22

3+
There are several useful instructions for different tasks. Each instruction is tailored to a specific role or task,
4+
ensuring clarity and efficiency in the process.
5+
6+
CTX supports also prompts definition straight in the `context.yaml` file. Read more about it in the [Prompts](/prompts)
7+
section.
8+
39
## PHP Developer
410

511
```
@@ -297,4 +303,18 @@ repositories).
297303
298304
By following these principles, repositories will become the **single source of truth** for querying entities,
299305
improving maintainability and consistency in the application.
300-
```
306+
```
307+
308+
## **Shared Prompts Resources:**
309+
310+
CTX supports importing prompts from external sources, allowing you to leverage community-maintained prompt libraries.
311+
You can add ready-to-use prompts to your project by adding the following to your `context.yaml`:
312+
313+
```yaml
314+
import:
315+
- type: url
316+
url: https://gist.githubusercontent.com/butschster/1b7e597691cc1a6476b15dc120ecbddb/raw/9cda0186689e5c819e1f60b486a9d960fcf412c2/prompts.yaml
317+
```
318+
319+
These shared prompt collections can help standardize approaches to common development tasks across your team and
320+
projects. **For more details on working with prompts, see the [Prompts documentation](/prompts)**.

docs/advanced/logging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Logging
22

3-
Context Generator includes a PSR-3 compliant logging system with console output support. The logger integrates with
3+
**CTX** includes a PSR-3 compliant logging system with console output support. The logger integrates with
44
Symfony Console and respects verbosity levels.
55

66
### Verbosity Levels

docs/advanced/smart-context-requesting.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ requests without the need for predefined configuration files.
99

1010
Before diving into advanced usage, you need to understand:
1111

12-
1. **JSON Schema**: The Context Generator uses a specific JSON structure to define what context to gather
12+
1. **JSON Schema**: **CTX** uses a specific JSON structure to define what context to gather
1313

1414
> Link to the [JSON Schema](https://raw.githubusercontent.com/context-hub/generator/refs/heads/main/json-schema.json)
1515
@@ -34,7 +34,7 @@ through executable commands. This creates a feedback loop that significantly enh
3434

3535
## Real-World Example Workflow
3636

37-
Here's a complete workflow example showing how an LLM and the Context Generator can work together:
37+
Here's a complete workflow example showing how an LLM and the **CTX** can work together:
3838

3939
1. **User Question**:
4040

@@ -127,7 +127,7 @@ When working with sensitive codebases:
127127

128128
## Conclusion
129129

130-
The combination of Context Generator's inline configuration and LLMs creates a powerful workflow that drastically
130+
The combination of **CTX**'s inline configuration and LLMs creates a powerful workflow that drastically
131131
improves the efficiency of code assistance, troubleshooting, and development guidance. By enabling LLMs to request
132132
precise context, you eliminate the need for lengthy explanations and manual code searching, leading to faster and more
133133
accurate solutions.

docs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ documents:
211211

212212
## Using variables in configuration
213213

214-
Context Generator supports various types of variables throughout your configuration files, including environment
214+
**CTX** supports various types of variables throughout your configuration files, including environment
215215
variables, predefined system variables, and custom configuration variables.
216216

217217
Read more about [variables](./variables.md) in the documentation.

docs/contributing.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
1-
# Contributing to Context Generator
1+
# Contributing to **CTX**
22

3-
We're excited to welcome you as a contributor to the Context Generator project! This guide will help you get started
3+
We're excited to welcome you as a contributor to the **CTX** project! This guide will help you get started
44
with contributing to our project.
55

66
## How to Contribute
77

8-
There are many ways to contribute to Context Generator:
8+
There are many ways to contribute to **CTX**:
99

1010
1. **Report Issues**: If you find a bug or have a
1111
suggestion, [create an issue](https://github.com/context-hub/generator/issues) on our GitHub repository.
1212
2. **Submit Pull Requests**: Have a fix or a new feature? Submit a pull request!
1313
3. **Improve Documentation**: Help us make our documentation more clear, comprehensive, and accessible.
14-
4. **Share Your Use Cases**: Let us know how you're using Context Generator in your projects.
14+
4. **Share Your Use Cases**: Let us know how you're using **CTX** in your projects.
1515

1616
We label issues that are suitable for community contribution with the `help wanted` tag. Additionally, we use labels
1717
such as `good first issue` for newcomer-friendly tasks, and complexity indicators to help you choose tasks that match
1818
your experience level.
1919

2020
I'd be happy to write a better instruction for the Getting Started section that highlights the use of the context.yaml
21-
file for context generation. This will help new contributors understand how they can use Context Generator itself to
21+
file for context generation. This will help new contributors understand how they can use **CTX** itself to
2222
explore and work with the codebase.
2323

2424
## Getting Started with Contributing
2525

26-
Follow this guide to set up your environment and effectively contribute to the Context Generator project. We've designed
26+
Follow this guide to set up your environment and effectively contribute to the **CTX** project. We've designed
2727
a workflow that leverages the tool's own capabilities to help you understand and improve the codebase.
2828

2929
### 1. Set Up Your Environment
@@ -83,7 +83,7 @@ Run this configuration to generate a visual representation of the codebase struc
8383
This will create a `docs/file-structure.md` file that outlines the project's organization. Just put this file in the
8484
Claude project context to help it understand the codebase.
8585

86-
### 3. Explore the Codebase Using Context Generator
86+
### 3. Explore the Codebase Using **CTX**
8787

8888
The project includes a pre-configured `context.yaml` file to help you explore the codebase:
8989

@@ -220,7 +220,7 @@ documents:
220220
- Include relevant context files or excerpts
221221
- Reference any related issues
222222
223-
By using Context Generator in your contribution workflow, you'll not only improve the project but also gain firsthand
223+
By using **CTX** in your contribution workflow, you'll not only improve the project but also gain firsthand
224224
experience with the tool while developing more effective collaboration patterns with AI assistants.
225225
226226
## Areas Where Help Is Needed
@@ -232,12 +232,12 @@ We're particularly looking for help with:
232232
- Creating specialized content modifiers for different languages
233233
- Building integrations with popular IDEs and tools
234234
235-
Your contributions, big or small, help make Context Generator a better tool for everyone. We look forward to
235+
Your contributions, big or small, help make **CTX** a better tool for everyone. We look forward to
236236
collaborating with you!
237237
238238
## Questions?
239239
240240
If you have any questions about contributing, feel free to open an issue labeled "question" or reach out through the
241241
[discussions](https://github.com/context-hub/generator/discussions) section on GitHub.
242242
243-
Thank you for considering contributing to Context Generator!
243+
Thank you for considering contributing to **CTX**!

docs/documents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Document
22

3-
A document is the primary output unit produced by the Context Generator. It represents a complete, formatted context
3+
A document is the primary output unit produced by the **CTX**. It represents a complete, formatted context
44
file that's designed to be shared with Large Language Models (LLMs) like ChatGPT or Claude.
55

66
Each document produces a single output file (typically Markdown) that contains all the compiled

docs/getting-started.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ The PHAR file can be used on any system with PHP 8.2 or higher.
1414

1515
### Requirements
1616

17-
- Linux or MacOS
17+
- Linux,
18+
- MacOS
19+
- or Windows with or without WSL
1820

1921
The easiest way to install Context Generator is by using our installation script. This automatically downloads the
2022
latest version and sets it up for immediate use.
@@ -39,6 +41,8 @@ If you install to a system directory like `/usr/local/bin`, you probably need `s
3941
curl -sSL https://raw.githubusercontent.com/context-hub/generator/main/download-latest.sh | sudo sh
4042
```
4143

44+
> **Note**: When using `sudo`, to run the script, you may need use `sudo` to run the `ctx` command as well.
45+
4246
Install to a custom path to avoid using `sudo`:
4347

4448
```bash

0 commit comments

Comments
 (0)