Skip to content

Commit 4991913

Browse files
committed
docs: mark repository as under construction
1 parent f4a7dba commit 4991913

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,26 @@
11
# SwiftMonocle
22

3-
SwiftMonocle is a macOS Swift package scaffold for a focused library project.
3+
SwiftMonocle is an early macOS-first Swift package for building scoped, syntax-aware coding context.
44

55
## Overview
66

77
### Motivation
88

9-
This repository starts from a clean Swift Package Manager baseline so the core package shape, local repo maintenance scripts, and repo-local Codex plugin wiring are already in place before product work begins.
9+
The project is exploring a single canonical `CodeScope` model that can merge editor context, syntax-derived symbols, diagnostics, docs, and agent state into one bounded snapshot for local coding workflows.
1010

1111
### Current status
1212

13-
The package is intentionally minimal right now. The immediate goal is to keep the repository organized, reproducible, and ready for the first real implementation pass.
13+
SwiftMonocle is very under construction.
14+
15+
The package is still in its foundation stage, the public API is not stable, and the repository is currently closer to a live design-and-implementation sandbox than a consumable library release.
16+
17+
Recent work has focused on:
18+
19+
- defining the first shared scope snapshot model
20+
- splitting the package into `Core` and `CodeScope` targets
21+
- wiring in the first `SwiftSyntax`-backed symbol extraction from live editor buffers
22+
23+
Expect rapid changes, missing features, rough edges, and frequent restructuring while the real product boundary settles.
1424

1525
## Requirements
1626

@@ -31,6 +41,8 @@ Run the tests:
3141
swift test
3242
```
3343

44+
This build is still exploratory. Passing builds and tests only mean the current prototype is internally consistent, not that the package is feature-complete or ready for external adoption.
45+
3446
Run the repo-maintenance validation wrapper:
3547

3648
```bash
@@ -40,7 +52,9 @@ scripts/repo-maintenance/validate-all.sh
4052
## Repository Layout
4153

4254
- `Sources/SwiftMonocle`: package source
43-
- `Tests/SwiftMonocleTests`: package tests
55+
- `Sources/SwiftMonocleCore`: shared snapshot, reference, and scope model types
56+
- `Sources/SwiftMonocleCodeScope`: scope assembly and syntax-driven symbol extraction
57+
- `Tests`: package test suites
4458
- `scripts/repo-maintenance`: validation and release helpers installed during bootstrap
4559
- `.codex/plugins`: repo-local Codex plugin install surface
4660

@@ -52,4 +66,4 @@ Because the local Codex app-server install RPC did not return a `plugin/install`
5266

5367
## Planning
5468

55-
Project planning lives in [`ROADMAP.md`](./ROADMAP.md). Once the product direction is decided, update the roadmap and README together so the repo stays grounded in the same scope.
69+
Project planning lives in [`ROADMAP.md`](./ROADMAP.md), with additional maintainer design notes in [`docs/maintainers`](./docs/maintainers). Until the first product milestone is fully defined, treat the roadmap and the maintainer docs as the source of truth for what this repository is actually trying to become.

0 commit comments

Comments
 (0)