Skip to content

Commit 3360f47

Browse files
committed
Rename configuration files and update references from DocForgeConfig to KnowledgeConfig throughout the documentation to align with the new project structure.
1 parent 472cb00 commit 3360f47

File tree

7 files changed

+23
-23
lines changed

7 files changed

+23
-23
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ A modern, open-source documentation platform that transforms how teams create, o
3535
## 📁 Project Structure
3636

3737
```
38-
docforge/
38+
knowledge/
3939
├── src/ # Source code
4040
├── themes/
4141
│ └── default/
@@ -84,7 +84,7 @@ docforge/
8484

8585
## 📝 Configuration
8686

87-
The `docforge.config.ts` file contains all configuration options:
87+
The `knowledge.config.ts` file contains all configuration options:
8888

8989
```typescript
9090
export default {
@@ -101,7 +101,7 @@ export default {
101101
darkMode: true,
102102
tableOfContents: true
103103
}
104-
} as DocForgeConfig;
104+
} as KnowledgeConfig;
105105
```
106106

107107
## 🎯 Performance

docs/architecture.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ export class MarkdownProcessor {
6666
}
6767

6868
// src/config.ts - Configurations
69-
export interface DocForgeConfig {
69+
export interface KnowledgeConfig {
7070
inputDir: string
7171
outputDir: string
7272
site: SiteConfig
@@ -132,7 +132,7 @@ knowledge/
132132
│ └── page-highlighter.js
133133
├── docs/ # Source documentation
134134
├── dist/ # Generated output
135-
└── docforge.config.ts # Project configuration
135+
└── knowledge.config.ts # Project configuration
136136
```
137137

138138
## Main Components
@@ -218,13 +218,13 @@ theme/
218218
### Configuration Hierarchy
219219

220220
1. **Default configuration** (src/config.ts)
221-
2. **Project configuration** (docforge.config.ts)
221+
2. **Project configuration** (knowledge.config.ts)
222222
3. **CLI arguments** (override configurations)
223223

224224
### Configuration Types
225225

226226
```typescript
227-
interface DocForgeConfig {
227+
interface KnowledgeConfig {
228228
// Directories
229229
inputDir: string
230230
outputDir: string

docs/development.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ knowledge/
100100
- **Functions**: camelCase (`generateNavigation`)
101101
- **Constants**: UPPER_SNAKE_CASE (`DEFAULT_CONFIG`)
102102
- **Interfaces**: PascalCase with I prefix (`ISearchResult`)
103-
- **Types**: PascalCase (`DocForgeConfig`)
103+
- **Types**: PascalCase (`KnowledgeConfig`)
104104

105105
## Code Standards
106106

@@ -184,7 +184,7 @@ class DocumentationError extends Error {
184184
}
185185
}
186186

187-
function validateConfig(config: DocForgeConfig): void {
187+
function validateConfig(config: KnowledgeConfig): void {
188188
if (!config.inputDir) {
189189
throw new DocumentationError(
190190
'Input directory is required',
@@ -280,7 +280,7 @@ bun test tests/e2e/
280280

281281
```typescript
282282
// tests/helpers/mocks.ts
283-
export const mockConfig: DocForgeConfig = {
283+
export const mockConfig: KnowledgeConfig = {
284284
inputDir: './test-docs',
285285
outputDir: './test-dist',
286286
site: {

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ This is the complete index of the Knowledge system documentation. Here you will
6868
### APIs and Interfaces
6969
| Interface | Description | Document |
7070
|-----------|-----------|-----------|
71-
| `DocForgeConfig` | Main configuration | [API Reference](./reference.md#docforgeconfig) |
71+
| `KnowledgeConfig` | Main configuration | [API Reference](./reference.md#knowledgeconfig) |
7272
| `DocumentationGenerator` | Main generator | [API Reference](./reference.md#documentationgenerator) |
7373
| `SearchIndexGenerator` | Search system | [API Reference](./reference.md#searchindexgenerator) |
7474
| `DevServer` | Development server | [API Reference](./reference.md#devserver) |

docs/installation.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -85,17 +85,17 @@ This will create the following structure:
8585
my-documentation/
8686
├── docs/ # Source documentation
8787
│ └── README.md # Home page
88-
├── docforge.config.ts # Main configuration
88+
├── knowledge.config.ts # Main configuration
8989
├── package.json # Project dependencies
9090
└── .gitignore # Git ignored files
9191
```
9292

9393
### 2. Basic Configuration
9494

95-
Edit the `docforge.config.ts` file:
95+
Edit the `knowledge.config.ts` file:
9696

9797
```typescript
98-
import type { DocForgeConfig } from './src/config.js';
98+
import type { KnowledgeConfig } from './src/config.js';
9999

100100
export default {
101101
// Directories
@@ -144,7 +144,7 @@ export default {
144144
host: 'localhost',
145145
livereload: true
146146
}
147-
} as DocForgeConfig;
147+
} as KnowledgeConfig;
148148
```
149149

150150
### 3. Documentation Structure
@@ -644,7 +644,7 @@ bun run src/cli.ts build --verbose
644644
find docs -name "*.md" -exec echo "Checking: {}" \; -exec head -1 {} \;
645645

646646
# Verify config syntax
647-
bun run -e "import('./docforge.config.ts')"
647+
bun run -e "import('./knowledge.config.ts')"
648648
```
649649

650650
#### 3. Server Not Starting
@@ -708,7 +708,7 @@ else
708708
fi
709709

710710
# Verify configuration
711-
if [ -f "docforge.config.ts" ]; then
711+
if [ -f "knowledge.config.ts" ]; then
712712
echo "✅ Configuration found"
713713
else
714714
echo "⚠️ Configuration not found - execute 'bun run init'"
@@ -739,7 +739,7 @@ After installation and configuration:
739739

740740
- 📖 **Documentation**: [knowledge.dev](https://knowledge.dev)
741741
- 🐛 **Issues**: [GitHub Issues](https://github.com/riligar/knowledge/issues)
742-
- �� **Discussions**: [GitHub Discussions](https://github.com/riligar/knowledge/discussions)
742+
- 💬 **Discussions**: [GitHub Discussions](https://github.com/riligar/knowledge/discussions)
743743
- 📧 **Email**: [suporte@riligar.click](mailto:suporte@riligar.click)
744744

745745
---

docs/readme.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ knowledge/
6363
│ └── js/ # JavaScript scripts
6464
├── docs/ # Source documentation
6565
├── dist/ # Generated output
66-
└── docforge.config.ts # Main configuration
66+
└── knowledge.config.ts # Main configuration
6767
```
6868

6969
## Quick Start
@@ -108,7 +108,7 @@ bun run serve
108108

109109
## Configuration
110110

111-
The `docforge.config.ts` file contains all configuration options:
111+
The `knowledge.config.ts` file contains all configuration options:
112112

113113
```typescript
114114
export default {
@@ -157,7 +157,7 @@ export default {
157157
host: 'localhost',
158158
livereload: true
159159
}
160-
} as DocForgeConfig;
160+
} as KnowledgeConfig;
161161
```
162162

163163
## CLI Commands

docs/reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ This documentation provides a complete API reference for Knowledge, including Ty
66

77
## Main Configuration
88

9-
### DocForgeConfig
9+
### KnowledgeConfig
1010

1111
Main system configuration interface.
1212

1313
```typescript
14-
interface DocForgeConfig {
14+
interface KnowledgeConfig {
1515
// Directories
1616
inputDir: string
1717
outputDir: string

0 commit comments

Comments
 (0)