bendtherules/ask262
1
0
Fork 0
mirror of https://github.com/bendtherules/ask262.git synced 2026-08-18 13:21:55 +00:00
Code Issues 1 Packages Projects Releases Wiki Activity

docs: remove config.json references and update setup instructions

Browse Source
This commit is contained in:
bendtherules
2026-04-14 17:25:05 +05:30
parent c239e28119
commit d248fe1b09
2 changed files with 4 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+2 -5
View File
@@ -15,7 +15,6 @@ Users ask questions like: *"How does the if statement work?"* or *"Which functio
- **Node.js** 18+ with Bun runtime (packageManager: bun@1.2.8) - **Node.js** 18+ with Bun runtime (packageManager: bun@1.2.8)
- **Ollama** installed locally with embedding model (e.g., `qwen3-embedding:0.6b`) - **Ollama** installed locally with embedding model (e.g., `qwen3-embedding:0.6b`)
- **OpenAI-compatible endpoint** (NVIDIA or other) configured in `config.json`
## Project Structure ## Project Structure
@@ -44,7 +43,6 @@ ask262/
│ ├── verify-db.ts # Verify database contents │ ├── verify-db.ts # Verify database contents
│ ├── test-search-spec-sections.ts # Test vector search tool │ ├── test-search-spec-sections.ts # Test vector search tool
│ └── test-evaluate-in-engine262.ts # Test evaluate tool │ └── test-evaluate-in-engine262.ts # Test evaluate tool
├── config.json # API keys and endpoints (user-created)
├── spec-built/multipage/ # ECMAScript spec HTML files ├── spec-built/multipage/ # ECMAScript spec HTML files
├── engine262/src/ # JavaScript engine implementation ├── engine262/src/ # JavaScript engine implementation
├── storage/ # Vector index persistence (LanceDB) ├── storage/ # Vector index persistence (LanceDB)
@@ -171,7 +169,7 @@ Before running the MCP server:
### Error Handling ### Error Handling
- Use `try/catch` for async operations with meaningful error messages - Use `try/catch` for async operations with meaningful error messages
- Validate environment variables (e.g., `NVIDIA_API_KEY` in config.json) - Validate environment variables
- Check file existence before reading - Check file existence before reading
- Log warnings for missing configuration rather than failing silently - Log warnings for missing configuration rather than failing silently
@@ -189,5 +187,4 @@ Before running the MCP server:
1. Always use TypeScript for implementation - no plain JavaScript 1. Always use TypeScript for implementation - no plain JavaScript
2. Run type-check before committing: `bun run type-check` 2. Run type-check before committing: `bun run type-check`
3. Ingest and build commands can take significant time due to local embedding generation 3. Ingest and build commands can take significant time due to local embedding generation
4. The agent relies on `config.json` for API credentials (not committed to git) 4. External directories (`spec-built/`, `engine262/`, `graphology/`) should not be modified by linting/formatting
5. External directories (`spec-built/`, `engine262/`, `graphology/`) should not be modified by linting/formatting
Readme.md
+2 -8
View File
@@ -31,18 +31,12 @@ bun install
## Setup ## Setup
1. **Prepare environment**: 1. **Ensure spec is present** (only external requirement):
```bash
export OPENAI_API_BASE="your_endpoint_base_url" # Optional
export OPENAI_API_KEY="your_api_key" # Optional
```
2. **Ensure spec is present** (only external requirement):
- `./spec-built/multipage/` - ECMAScript spec HTML files - `./spec-built/multipage/` - ECMAScript spec HTML files
*Note: `storage/` (pre-built vectors), `engine262/lib/`, and `graphology/` are included in the package.* *Note: `storage/` (pre-built vectors), `engine262/lib/`, and `graphology/` are included in the package.*
3. **Build knowledge graph** (first time only, if using custom spec): 2. **Build knowledge graph** (first time only, if using custom spec):
```bash ```bash
bun run build bun run build
``` ```