Skip to content

Commit 7eac853

Browse files
authored
Update README.md
1 parent b032d5b commit 7eac853

File tree

1 file changed

+32
-16
lines changed

1 file changed

+32
-16
lines changed

README.md

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -63,27 +63,43 @@ There are [many more examples](test/corpus) to look at...
6363

6464
# Planned Features
6565

66-
## ONBOARDING
66+
## Onboarding Capabilities
6767

68-
An LLM (or a human) will be able to use the commands below to get to know a new codebase:
68+
This capability is designed to help developers, AI assistants, and other tools quickly gain a comprehensive understanding of a project's structure, conventions, and context.
6969

70-
```sql
71-
-- Read contents of CONVENTIONS.md
72-
SELECT CONVENTIONS
73-
FROM ONBOARDING;
70+
### Key Onboarding Features
7471

75-
-- Read contents of codebase context files:
76-
-- .context.md (primary, may be in json or yaml form)
77-
-- .contextdocs.md
78-
-- .contextignore
79-
SELECT CONTEXT
80-
FROM ONBOARDING;
72+
1. **Convention Discovery**:
73+
CEDARScript can automatically extract coding conventions from designated files like `CONVENTIONS.md`:
8174

82-
-- Read all you should know about the current project
83-
SELECT *
84-
FROM ONBOARDING
75+
```sql
76+
SELECT CONVENTIONS
77+
FROM ONBOARDING;
78+
```
8579

86-
```
80+
2. **Context Retrieval**:
81+
Quickly access project context from files like `.context.md` or `.contextdocs.md`:
82+
83+
```sql
84+
SELECT CONTEXT
85+
FROM ONBOARDING;
86+
```
87+
88+
3. **Comprehensive Project Overview**:
89+
Gather all essential project information in one query:
90+
91+
```sql
92+
SELECT *
93+
FROM ONBOARDING;
94+
```
95+
96+
### Future Enhancements
97+
98+
Ideas to explore:
99+
100+
- Automatic generation of project structure visualizations
101+
- Integration with version control history for context-aware onboarding
102+
- Customizable onboarding queries for specific project needs
87103

88104
# Future Work
89105

0 commit comments

Comments
 (0)