Skip to content

Commit fb23109

Browse files
committed
docs: update v0.5 references
1 parent e32308e commit fb23109

File tree

6 files changed

+16
-24
lines changed

6 files changed

+16
-24
lines changed

README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -191,20 +191,15 @@ Join us on
191191
[GitHub Discussions](https://github.com/OmniScriptOSF/omniscript-core/discussions)
192192
to propose ideas, ask questions, or share feedback.
193193

194-
---
195-
196-
## 🌐 Resources (coming soon)
197-
198-
- Project website & docs
199-
- Interactive OSF viewer
200-
- Conversion tools
201-
- Example repository
202-
- Roadmap and specification drafts
203-
204-
---
205194

206195
## 💡 Vision
207196

208197
OmniScript Format (OSF) aims to be the universal document source language — a
209198
single plain-text format powering documents, presentations, and data tables in a
210199
world of AI collaboration and versioned knowledge.
200+
201+
## ❗ Known Limitations (v0.5)
202+
203+
- The initial CLI only covers parsing, linting and basic rendering; advanced conversion targets are under development.
204+
- Diagram blocks, citation syntax and macro support are planned for future revisions.
205+
- Formal grammar and normative references are scheduled for a later appendix release.

docs/architecture.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@ This repository hosts the reference implementation of **OmniScript Format
44
(OSF)**. The codebase is organised as a monorepo with separate packages for the
55
parser and CLI.
66

7-
The `spec/` directory contains versioned specifications. The current draft is
8-
[spec/v0.5](../spec/v0.5/) which defines the grammar and JSON schema used by the
9-
parser.
7+
The `spec/` directory contains versioned specifications. The current release is [spec/v0.5](../spec/v0.5/) which defines the grammar and JSON schema used by the parser.
108

119
```
1210
omniscript-core/

docs/contributing.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22

33
We welcome pull requests!
44

5-
1. Read the OSF draft in [spec/v0.5](../spec/v0.5/) to understand the current
6-
language features.
5+
1. Read the OSF v0.5 specification in [spec/v0.5](../spec/v0.5/) to understand the current language features.
76
2. Follow the coding style used in the parser and CLI packages.
87
3. Tests are located under `tests/` and `parser/tests`. Please add tests for new
98
functionality.

docs/design-decisions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This project follows the OSF v0.5 specification located under `spec/v0.5`. The
44
core blocks – `@meta`, `@doc`, `@slide` and `@sheet` – are implemented as
5-
described in that draft.
5+
described in that release.
66

77
- **Parser simplicity** – The reference parser mirrors the grammar in
88
`spec/v0.5/grammar.ebnf` to keep implementations easy to understand.

docs/spec-v0.5-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# OSF v0.5 Overview
22

3-
This document summarises the key elements of the OmniScript Format v0.5 draft.
3+
This document summarises the key elements of the OmniScript Format v0.5 specification.
44
Refer to the files under `spec/v0.5/` for the authoritative specification.
55

66
## Core Blocks

spec/v0.5/osf-spec.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# OmniScript Format (OSF) – Specification Draft
1+
# OmniScript Format (OSF) – v0.5 Specification
22

33
**OmniScript Format (OSF)** is a new domain-specific language (DSL) designed as
44
_“the universal document DSL for LLMs, agentic AI, and Git-native workflows.”_
@@ -492,20 +492,20 @@ outlines the tooling and how users can work with OSF documents:
492492
features as they become necessary. For now, typical use (a few hundred pages
493493
or slides, moderate data) is easily handled by modern computers.
494494

495-
The **implementation status**: At the time of this draft, the core parser and
495+
The **implementation status**: At the time of this release, the core parser and
496496
initial CLI commands are under development in the `omniscript-core` repository.
497497
Example OSF documents and tests are provided there to illustrate usage.
498498
Community contributions are welcome to expand the tooling (see **Contributing**
499499
guidelines in the repository).
500500

501501
## Roadmap
502502

503-
OSF is currently a draft specification and prototype. The roadmap below outlines
503+
OSF is currently an early-stage specification and prototype. The roadmap below outlines
504504
the path toward a stable 1.0 release and beyond, indicating both technical
505505
milestones and standardization efforts:
506506

507-
- **v0.5 – Draft Specification & Prototype (2025):** The focus is on validating
508-
the core ideas. Deliverables include this draft spec, the reference parser,
507+
- **v0.5 – Initial Specification & Prototype (2025):** The focus is on validating
508+
the core ideas. Deliverables include this specification, the reference parser,
509509
and basic CLI functionality (parse, render to a couple of formats, basic
510510
lint). Feedback is solicited from early adopters, especially regarding the
511511
syntax choices and conversion fidelity.
@@ -592,7 +592,7 @@ robust and widely adopted.
592592

593593
_The following appendices will provide detailed technical specifications and
594594
references in a future revision of this document. They are outlined here for
595-
completeness but are not yet included in this draft._
595+
completeness but are not yet included in this release._
596596

597597
### Appendix A: OSF Grammar Definition (BNF)
598598

0 commit comments

Comments
 (0)