Cluster detail
tutorials.rq
Ideas defined in reqlan rq/marketing_and_media/tutorials.rq.
file
28 ideas
1 files
| Idea | File | Status | Summary |
|---|---|---|---|
| adv_01_imports_ideasets | reqlan rq/marketing_and_media/tutorials.rq | Audience: builders with a single-file graph who feel reference sprawl or duplicate idea names across files. Outcome: split ideas across files; use `from` / `import` and namespace import; group with ideasets; resolve qualified references without breaking call-site readability. Runtime: 9 – 10 min. Demo: advanced baseline open on `reqs/product.rq`; `reqs/auth.rq` exists with `login_api` and `session_policy` but `product.rq` still references them without imports — caret on a broken or unresolved link. Related: [import_from] [import_namespace] [ideaset] [file] [reference] | |
| adv_02_attributes_status_plans | reqlan rq/marketing_and_media/tutorials.rq | ||
| adv_overview | reqlan rq/marketing_and_media/tutorials.rq | Audience: viewers who finished get-started and concepts ( or equivalent ) and want the map of craft themes before committing to a deep dive. Outcome: name the eight advanced themes, understand how they connect to get-started discipline, and pick a first episode. Runtime: 3 – 4 min. Demo: `reqlan-tutorials-demo` at advanced baseline — multi-file graph, `.reqlan` present, no new files typed; montage only. Related: [advanced_series_brief] [general_purpose] [llm_first] [concepts_series] [base] [multi_base_environment] | |
| advanced_series | reqlan rq/marketing_and_media/tutorials.rq | Ideaset (advanced_series) | |
| advanced_series_brief | reqlan rq/marketing_and_media/tutorials.rq | draft | Advanced series: eight episodes in [advanced_series], about 8 – 12 minutes each, plus [adv_overview]. Assumes get-started fluency and ideally [concepts_series] vocabulary ( or equivalent ). Goal: multi-file graphs, purposeful attributes, cartographic navigation, AI token discipline, code-comment traceability, HTML publishing, headless CLI / MCP craft ( beyond [con_03_cli] ), and modelling patterns that stay readable. Include at least one non-software vignette ( ops runbook or editorial brief ) to honour [general_purpose]. Bases appear as craft judgement ( active base, nested boundaries ) — not a second create-base lesson. Decks: [adv_overview] and adv_01 – adv_08 under [slide_decks]. |
| con_01_ontology | reqlan rq/marketing_and_media/tutorials.rq | Audience: viewers who finished get-started ( or equivalent ) and want shared vocabulary without repeating the install loop. Outcome: define each core ontology noun in one sentence; place [base] as graph boundary ( including nesting ); distinguish [attribute_body] from optional `@` metadata; name [cartographic_map] as a chosen cut, not a mandatory dump. Runtime: 10 – 12 min. Demo: `reqlan-tutorials-demo` at get-started end state — `.reqlan/` present; `reqs/product.rq`, `reqs/auth.rq`, `src/login.ts`; caret starts on `welcome_flow` in `product.rq`. Related: [idea] [ideaset] [file] [base] [base_detail] [reference] [attribute] [attribute_body] [cartographic_map] [referenced_files] [configuration] [base_nesting] [multi_base_environment] | |
| con_02_extension_tour | reqlan rq/marketing_and_media/tutorials.rq | Audience: viewers who know the ontology nouns and want a calm map of where they appear in the product. Outcome: name the primary [extension] surfaces and which job each owns; know where not to dig on day two. Runtime: 8 – 10 min. Demo: full get-started end state of `reqlan-tutorials-demo` ( `.reqlan`, `reqs/product.rq`, `reqs/auth.rq`, `src/login.ts` ); activity bar closed; Ideas Summary closed; chat available. Related: [extension] [activity_bar] [ideas_summary] [command_palette] [ai_integration] [html_export] [graph_view] [local_graph_view] [simple_views] [chat_skill_naming] [installation] [mcp_tools] [cli_package] [commands] | |
| con_03_cli | reqlan rq/marketing_and_media/tutorials.rq | Audience: viewers who finished the extension tour and want the headless twin named — CI, scripts, and agents without living in the editor. Outcome: install and run `reqlan` / `rq`; [init] a [base]; run search, analyse, and parse; know `--cwd` / `--json` and one-base-per-run; know export shares [html_export] with the extension. Runtime: 9 – 11 min. Demo: advanced get-started end state of `reqlan-tutorials-demo` — `.reqlan` indexed, `reqs/product.rq` + `reqs/auth.rq` present; integrated terminal at workspace root; extension idle in background ( not the focus ). Related: [cli_package] [commands] [init] [html_export] [base] [multi_base_environment] [llm_first] [function_parity] | |
| concepts_series | reqlan rq/marketing_and_media/tutorials.rq | Ideaset (concepts_series) | |
| concepts_series_brief | reqlan rq/marketing_and_media/tutorials.rq | draft | Short concepts series after get-started: three packs that put names to what the learner already felt. [con_01_ontology] — the building blocks: [idea], [ideaset], [file], [base], [reference], [attribute], and the focused map view ( [cartographic_map] ). [con_02_extension_tour] — where those building blocks appear across the [extension] surfaces. [con_03_cli] — the headless twin: [cli_package] / [commands] on the same `.reqlan` index ( [init], search, analyse, parse, export ). Runtime: about 8 – 12 minutes each. Optional for impatient builders; recommended before advanced. |
| demo_workspace | reqlan rq/marketing_and_media/tutorials.rq | Shared recording workspace name: `reqlan-tutorials-demo`. Never record against the reqlan monorepo itself — keep demos small and readable. Cumulative fixture map ( end state after each milestone ): - After gs_01: empty folder open ( or README only ); extension installed; onboarding seen once. - After gs_02: `reqs/product.rq` with `product_name` one-liner and `welcome_flow` block. No `.reqlan` yet. - After gs_03: `welcome_flow` ↔ `onboarding_checklist` linked; optional `account_model`. Still no `.reqlan`. - After gs_04: `.reqlan/` with `config.json` and `.rqignore`; ideas index present as tooling memory. Folder is a [base]. - After gs_05: same graph; viewer knows activity-bar sync, hop depth, copy-as-markdown. - After gs_06: `password_rules` idea present; chat / skills exercised once. - After gs_07: `reqs/auth.rq` with `login_api`; `src/login.ts` stub; file reference from idea to code. Concepts assume the full get-started end state ( including `.reqlan` ). [con_03_cli] uses the same fixture from a terminal at workspace root. Advanced baseline tree: Get-started 01 – 03 may start without `.reqlan`; from [gs_04_first_base] onward the folder is a real [base]. Advanced episodes may add imports, attributes, comment refs, and the newsletter vignette on camera. | |
| get_started_series | reqlan rq/marketing_and_media/tutorials.rq | Ideaset (get_started_series) | |
| get_started_series_brief | reqlan rq/marketing_and_media/tutorials.rq | draft | Short " get started " series: seven episodes in [get_started_series], about 4 – 7 minutes each, total under about 40 minutes. Goal: a new user can install reqlan, write ideas, link them, create a [base], inspect neighbourhood context, ask the chat participant, and point ideas at real files. Teaching order ( producer note, not on-screen copy ): demonstrate the core actions first; naming the building blocks waits for [concepts_series]. Tone: calm and concrete on screen — no feature-tour survey ( that is [con_02_extension_tour] ). End each episode with one " try this " prompt on screen. |
| gs_01_why_reqlan | reqlan rq/marketing_and_media/tutorials.rq | Audience: developers or knowledge workers who already talk to LLMs about their project and feel context drift. Outcome: viewer can explain reqlan in one sentence and knows where install / docs live. Runtime: 4 – 5 min. Demo: cold open on a fresh machine or reset profile. Folder `reqlan-tutorials-demo` does not exist yet — or an empty folder with only `README.md`. No `.rq` files. reqlan extension not installed ( or disabled ) until the install beat. Related: [mission_statement] [llm_first] [inspiration] [installation_event] [installation] [extension_installation] | |
| gs_02_first_idea | reqlan rq/marketing_and_media/tutorials.rq | Audience: freshly installed users who finished gs_01 or equivalent. Outcome: create a `.rq` file; write a one-liner and a block idea; save; see syntax highlighting and language mode. Runtime: 5 min. Demo: folder `reqlan-tutorials-demo` open in VS Code. Extension installed; onboarding seen once. Explorer shows empty tree or `README.md` only — no `reqs/` folder yet, no `.reqlan`. Related: [idea] [simple_idea] [block_idea] [simplicity] [file] | |
| gs_03_link_ideas | reqlan rq/marketing_and_media/tutorials.rq | Audience: users with at least one idea file from gs_02. Outcome: use bracket references and a wikilink; peek definition and go-to-definition; understand ideas as a navigable graph. Runtime: 6 min. Demo: `reqlan-tutorials-demo/reqs/product.rq` open. Caret inside `welcome_flow`. File contains `product_name` one-liner and `welcome_flow` block only — no links yet, no `account_model`, no `.reqlan`. Related: [reference] [reference_brackets] [reference_wikilink] [idea] | |
| gs_04_first_base | reqlan rq/marketing_and_media/tutorials.rq | Audience: users with a small linked graph who have not yet marked a base. Outcome: create a [base] ( `.reqlan` ); explain that a base is the boundary of one ideas graph and owns the ideas index; know extension install ≠ base create. Runtime: 5 – 6 min. Demo: `reqlan-tutorials-demo` with `reqs/product.rq` containing linked `welcome_flow` ↔ `onboarding_checklist` ( and optional `account_model` ). No `.reqlan` folder. Activity bar or Ideas Summary shows empty / create-base prompt. Caret on any idea in `product.rq`. Related: [base] [base_detail] [create_base_onboarding] [base_installation] [installation] [extension_installation] | |
| gs_05_activity_bar | reqlan rq/marketing_and_media/tutorials.rq | Audience: users with a small linked graph inside a [base]. Outcome: open the reqlan activity bar; follow editor focus with sync; adjust hop depth; copy a slice as markdown; glance at Ideas Summary without treating it as a full dump. Runtime: 6 – 7 min. Demo: `reqlan-tutorials-demo` is a [base] — `.reqlan/` present and index active. `reqs/product.rq` with linked `welcome_flow`, `onboarding_checklist`, optional `account_model`. Caret inside `welcome_flow`. Activity bar closed or on a non-reqlan view. Related: [activity_bar] [local_graph_view] [ideas_summary] [llm_first] [implied_context] [base] | |
| gs_06_chat_search | reqlan rq/marketing_and_media/tutorials.rq | Audience: users ready to involve AI without abandoning the graph. Outcome: invoke `@reqlan /rq-search` ( VS Code Chat ) or Cursor skill `rq-search`; find an idea by meaning; add to context; optionally build a requirement from intent. Runtime: 6 min. Demo: same base and `reqs/product.rq` as gs_05. Add `password_rules` if missing — otherwise type it live at cold open. No chat thread open yet. `.reqlan` index active. Related: [ai_integration] [chat_skill_naming] [ai_add_to_context] [ai_build_requirement] [mcp_tools] [command_palette] | |
| gs_07_link_code | reqlan rq/marketing_and_media/tutorials.rq | Audience: users with application source beside `reqs/` who completed gs_01 – 06. Outcome: add a file reference from an idea to implementation; open the file from the requirement; see reverse scope when standing in code; recap the get-started loop into Concepts. Runtime: 6 – 7 min. Demo: base active. `reqs/product.rq` with linked ideas and `password_rules`. No `reqs/auth.rq` yet. No `src/` folder. Caret in `product.rq`. Explorer shows only `reqs/` and `.reqlan/`. Related: [any_file_scope] [context_scope] [reference] [referenced_files] [file] | |
| presentation_assets | reqlan rq/marketing_and_media/tutorials.rq | Shared files live under ["../../presentations/assets/"]. Required: logo ( copy of ["../../site/public/logo.svg"] ). Optional placeholders: montage-ide, activity-bar, chat-search, file-link ( SVG or PNG keys referenced from decks ). Public asset serving must stay aligned with [site_reqs.assets]. | |
| slide_decks | reqlan rq/marketing_and_media/tutorials.rq | Ideaset (slide_decks) | |
| slide_pack_format | reqlan rq/marketing_and_media/tutorials.rq | Each published episode that ships a deck declares an `@slides` list. Each slide item is an anonymous block with: - id — stable slide handle - transition — reveal transition name per [slide_transitions] - background — theme key per [slide_visual_system] - kicker / heading / body — on-screen copy ( minimal ) - code / code_lang — optional fenced snippet shown on the slide - asset — key into [presentation_assets] - fragments — optional comma-separated fragment labels ( fade-in ) - notes — speaker notes, usually the VO lines from `@script` Authored deck JSONC under ["../../presentations/decks/"] is the editable source of truth derived from `@slides`. Authored catalog JSONC: ["../../presentations/manifest.jsonc"]. Runtime deck JSON consumed by [site_reqs.presentation_player_route] is generated from those JSONC sources. Standalone Reveal shell ( optional local serve ): ["../../presentations/player/"] Site embed and lesson routing follow [site_reqs.tutorials_section] and [site_reqs.presentation_player_route]. | |
| slide_transitions | reqlan rq/marketing_and_media/tutorials.rq | Default deck transition: fade. Use slide for section / series breaks. Use none for side-by-side code-compare beats so the eye stays on the content. Fragment animation: fade-in for try-this prompts and CTAs. | |
| slide_visual_system | reqlan rq/marketing_and_media/tutorials.rq | Brand from [brand]: dark rust base, aqua accent, pink highlight. Quiet chrome per [show_dont_tell] — no dense labels on slides; narration carries detail. Background keys: brand-dark, brand-panel, brand-contrast. Typography: one heading, one short body, optional code block; logo on title and end cards. | |
| tutorial_format | reqlan rq/marketing_and_media/tutorials.rq | Production bar — every episode idea below must carry all of: - Audience, Outcome, Runtime ( always present — including advanced packs ) - Demo — explicit pre-state of `reqlan-tutorials-demo` at cold open ( files present, caret, UI already open ) - Related — feature requirement links the episode proves; `@todo` if a demoed surface is not `@status done` - `@example` — full recreateable fixture ( multi-file when the beat needs it ), fenced as opaque snippets when the sample itself contains braces - `@script` — caption-ready spoken VO plus screen directions ( VO = voiceover; SCR = what to show ). Structure: cold open → teach beats → misconception or recovery beat → try-this → end card. Use exact Command Palette / chat paths. VS Code is primary; note Cursor skill / chat alternate when AI tools differ. Use SCR: / VO: labels, not bracket tags, so they are not parsed as [reference] links. Prefer denser beats over stretching runtime. - `@slides` — one slide per major SCR beat ( ~ 7 – 10 ). Title, teach, try-this / end. `notes` = VO lines from `@script`. Authored Reveal JSONC under ["../../presentations/decks/"] is derived from `@slides` and may add JSONC-only fields ( `code_label`, dual-pane `code` / `code_b` ) for contrast beats. Episodes are self-contained; series order is recommended: get-started → concepts → advanced. After get-started 01 – 02, later get-started episodes can be sampled; concepts packs assume the loop was felt at least once. Prefer 1080 p screen capture with a small inset face cam optional; logo end-card with site / marketplace links from [phonebook]. Stay inside stated runtimes where possible ( get-started ~ 4 – 7 min, concepts ~ 8 – 12 min, advanced ~ 8 – 12 min ). | |
| tutorial_philosophy | reqlan rq/marketing_and_media/tutorials.rq | Producers may cite [mission_statement], [llm_first], [vsc_first], [general_purpose], [simplicity], and [inspiration] as constraints on what an episode must prove. These shape production choices — they are never spoken to, or shown to, the learner. Production guidance per constraint: - [llm_first]: demonstrate focused context — search, local slice, add-to-context — by doing it on camera before pasting a whole workspace. Never let VO or a slide label the workflow as a philosophy. - [vsc_first]: primary demos live in VS Code / compatible editors with the extension installed. - [general_purpose]: at least one get-started beat and one advanced beat use a non- " enterprise software " framing ( personal knowledge, ops checklist, or creative brief ). - [simplicity]: start with one-liners and one file; introduce braces, imports, and attributes only when the viewer feels the need. Show, then name: write a real idea, link it, create a base, open the activity bar — then put names to what the learner already did in [concepts_series]. Hard rule — learner-facing surfaces must never lecture. VO, any on-screen text the viewer reads ( title cards, end cards, callouts, quiz prompts ), slide heading / body / fragments / notes, try-this prompts, and fixture prose inside `@example` must NOT name: - product philosophy or constitution principles ( " llm-first ", " mission ", " semantic requirements as code ", " token discipline " ); - design lineage ( Obsidian, industrial control, " ontology " as a brand concept ); - syllabus pedagogy ( " verbs then nouns ", " teaches judgement " ); - taste lectures ( " simplicity over scaffolding ", " calm tiles, not a laundry list ", " keep copy short " ). Instead: show the workflow and the result, and name only surfaces and actions the user can perform. Producer teaching-order note ( guidance for planning, not copy for the screen ): get-started demonstrates the core actions; concepts puts names to the building blocks; advanced shows judgement. | |
| tutorials | reqlan rq/marketing_and_media/tutorials.rq | draft | Tutorial media teaches reqlan through short, scripted videos plus copy-pasteable `.rq` examples. Content must reflect [mission_statement]: semantic requirements as code for people working with LLMs, with ergonomic definition and consumption. Three series — do, then name, then craft: - [get_started_series]: first-hour fluency ( write, link, create a [base], neighbourhood, AI slice, code ). - [concepts_series]: ontology vocabulary, an [extension] surface map, and the [cli_package] headless surface after the learner has felt the loop. - [advanced_series]: graph craft, AI workflows, distribution. Host on the marketing site per [site_reqs.tutorials_section] and link from extension onboarding per [installation_event] and [phonebook]. Visual language follows [brand]; on-screen chrome stays quiet per [show_dont_tell] — narration carries concepts, UI does not lecture. |
Initialising graph…