Skip to content

docs: restructure docs and enforce 2.0 conventions - #13

Merged
Tcode-Motion merged 1 commit into
mainfrom
docs/restructure-docs-1513274867050769885
Aug 18, 2026
Merged

docs: restructure docs and enforce 2.0 conventions#13
Tcode-Motion merged 1 commit into
mainfrom
docs/restructure-docs-1513274867050769885

Conversation

@Tcode-Motion

Copy link
Copy Markdown
Owner

This pull request addresses the total restructuring and validation of the TechScript documentation site.

Actions Performed

  1. Auditing & Re-Mapping:

    • The flat docs/ folder had documentation spanning 20+ features mixed at the root level.
    • We executed an organizational remap into the correct categories: language/, compiler/, specification/, tooling/, guides/, reference/, and getting-started/.
    • Updated mkdocs.yml's nav object so that generated sites map correctly.
  2. Source of Truth Adjustments:

    • TechScript recently locked into LANGUAGE_FREEZE_2.0.md which declared changes like model dropping in favor of class.
    • Updated docs/language/types.md to properly reference class instead of class / model.
    • Pulled the true, frozen engineering grammar definition into docs/specification/grammar.md.
    • Moved and pulled the true engineering spec text into the public language-specification.md.
  3. Accuracy Check:

    • We ran cargo test --workspace and python3 verify_all_examples.py against the examples to ensure the existing syntax documented and run against TechScript still behaves normally despite our changes.

PR created automatically by Jules for task 1513274867050769885 started by @Tcode-Motion

…0 specs

- Restructured flat `docs/` folder into a structured hierarchy: getting-started, language, specification, compiler, tooling, reference, and guides.
- Rewrote the main language-specification and grammar documents to use explicit, validated contents extracted from the underlying frozen 2.0 engineering specs (`01_language_spec_v1.md` and `03_grammar_ebnf.md`).
- Addressed 2.0 conventions (e.g., `model` to `class` changes) in the type guide.
- Added implementation status tags to heavily used files (Types, Variables).
- Re-wired `mkdocs.yml`'s navigation structure to map to the new documentation directories.
- Confirmed zero-regression via workspace tests and example scripts.

Co-authored-by: Tcode-Motion <188012755+Tcode-Motion@users.noreply.github.com>
@google-labs-jules

Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@Tcode-Motion
Tcode-Motion marked this pull request as ready for review August 18, 2026 07:17
@Tcode-Motion
Tcode-Motion merged commit 9d3989c into main Aug 18, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant