scrapeRL / docs /README.md
NeerajCodz's picture
docs: init proto
24f0bf0
# documentation-index
This documentation set supersedes and expands `webscraper-openenv-softwaredoc.md` into focused modules.
## core-docs
- `overview.md` β€” top-level platform overview and documentation navigation
- `openenv.md` β€” enhanced OpenEnv spec, actions, observations, lifecycle
- `architecture.md` β€” system architecture, runtime, scheduling, scaling
- `agents.md` β€” multi-agent roles, strategies, HITL, explainability
- `rewards.md` β€” advanced reward function and signal breakdown
## platform-docs
- `api-reference.md` β€” complete HTTP and WebSocket endpoint reference
- `api.md` β€” multi-model API system and routing/ensemble/cost tracking
- `mcp.md` β€” MCP integration, registry, lazy install, composition
- `plugins.md` β€” plugin registry model, category matrix, runtime selection flow
- `search-engine.md` β€” search providers, query optimization, credibility scoring
- `html-processing.md` β€” semantic parsing, adaptive chunking, batch + diff processing
- `memory.md` β€” unified memory system (short/working/long/shared)
- `tool-calls.md` β€” step event contract and runtime tool-call payload patterns
## operations-docs
- `settings.md` β€” dashboard settings and configuration controls
- `observability.md` β€” metrics, traces, thought stream, cost telemetry
- `features.md` β€” advanced capabilities and feature flags
## legacy
- `webscraper-openenv-softwaredoc.md` remains as original monolithic source.
## document-metadata
| key | value |
| --- | --- |
| document | `readme.md` |
| status | active |
## document-flow
```mermaid
flowchart TD
A[document] --> B[key-sections]
B --> C[implementation]
B --> D[operations]
B --> E[validation]
```