From de25ee6630cbf3e2d560f5bd43b0efffc42bf7e7 Mon Sep 17 00:00:00 2001 From: dfuchss <22198798+dfuchss@users.noreply.github.com> Date: Tue, 25 Aug 2026 11:55:21 +0000 Subject: [PATCH] docs: update OpenWiki --- openwiki/.last-update.json | 10 ++++++---- openwiki/architecture.md | 7 +++++++ openwiki/domain.md | 7 +++++++ openwiki/index.md | 11 +++++++++++ openwiki/operations.md | 7 +++++++ openwiki/quickstart.md | 19 +++++++++++++++++++ openwiki/workflows.md | 7 +++++++ 7 files changed, 64 insertions(+), 4 deletions(-) create mode 100644 openwiki/index.md diff --git a/openwiki/.last-update.json b/openwiki/.last-update.json index a282897..931e113 100644 --- a/openwiki/.last-update.json +++ b/openwiki/.last-update.json @@ -1,6 +1,8 @@ { - "updatedAt": "2026-07-10T09:00:27.357Z", - "command": "init", - "gitHead": "aa2007481dbc2f4a60d1746c45efa2d49e8cd934", - "model": "openai/gpt-5.4-mini" + "updatedAt": "2026-08-25T11:55:20.971Z", + "command": "update", + "gitHead": "ff70c7a0302dada05523a3a603698e8df5512498", + "model": "z-ai/glm-5.2", + "status": "complete", + "language": "en" } diff --git a/openwiki/architecture.md b/openwiki/architecture.md index 4f024cc..0726e99 100644 --- a/openwiki/architecture.md +++ b/openwiki/architecture.md @@ -1,3 +1,10 @@ +--- +type: "Reference" +title: "Architecture" +description: "TraceView client-side Next.js App Router architecture: routing, React contexts, backend integration, result rendering, and change navigation." +tags: [architecture, nextjs, react-contexts, result-viewer] +--- + # Architecture TraceView is a client-heavy Next.js app built with the App Router. The UI is organized around three core areas: project creation, backend submission/polling, and result visualization. diff --git a/openwiki/domain.md b/openwiki/domain.md index 96c72d2..6ac4e59 100644 --- a/openwiki/domain.md +++ b/openwiki/domain.md @@ -1,3 +1,10 @@ +--- +type: "Reference" +title: "Domain model" +description: "ARDoCo traceability domain concepts for TraceView: artifact types, supported trace-link pipeline combinations, inconsistency analysis, and project identity." +tags: [domain, traceability, pipelines, artifact-types] +--- + # Domain model TraceView operates in the ARDoCo traceability domain. The application is less about generic file upload and more about combining specific software engineering artifacts into traceability and inconsistency-analysis runs. diff --git a/openwiki/index.md b/openwiki/index.md new file mode 100644 index 0000000..189ed7b --- /dev/null +++ b/openwiki/index.md @@ -0,0 +1,11 @@ +--- +okf_version: "0.1" +--- + +# Files + +- [Architecture](architecture.md) - TraceView client-side Next.js App Router architecture: routing, React contexts, backend integration, result rendering, and change navigation. +- [Domain model](domain.md) - ARDoCo traceability domain concepts for TraceView: artifact types, supported trace-link pipeline combinations, inconsistency analysis, and project identity. +- [Operations](operations.md) - TraceView development, build, lint, Docker, CI, and operational dependencies and risks. +- [OpenWiki quickstart](quickstart.md) - Entry point to the TraceView wiki: product overview, major sections, best starting points in source, and development commands. +- [Workflows](workflows.md) - TraceView user journeys from landing page through project setup, backend submission, result polling, and multi-panel result exploration. diff --git a/openwiki/operations.md b/openwiki/operations.md index 656c867..62a14f8 100644 --- a/openwiki/operations.md +++ b/openwiki/operations.md @@ -1,3 +1,10 @@ +--- +type: "Reference" +title: "Operations" +description: "TraceView development, build, lint, Docker, CI, and operational dependencies and risks." +tags: [operations, build, docker, ci, dependencies] +--- + # Operations This page covers the practical setup, validation, and CI details that matter when working in the repository. diff --git a/openwiki/quickstart.md b/openwiki/quickstart.md index a299363..a2c787e 100644 --- a/openwiki/quickstart.md +++ b/openwiki/quickstart.md @@ -1,3 +1,10 @@ +--- +type: "Reference" +title: "OpenWiki quickstart" +description: "Entry point to the TraceView wiki: product overview, major sections, best starting points in source, and development commands." +tags: [quickstart, navigation, traceview] +--- + # OpenWiki quickstart TraceView is a Next.js/React frontend for ARDoCo traceability link recovery. It lets a user create a project, upload architecture/documentation/code artifacts, send them to an ARDoCo backend, and inspect the returned trace links and inconsistencies in a multi-panel viewer. @@ -26,6 +33,18 @@ The repository README describes the same product framing and confirms the suppor - `src/app/view/[id]/page.tsx` — result polling and result viewer bootstrap - `src/util/ArdocoApi.tsx` — request construction for the ARDoCo backend +## Task routing + +| Change area or intent | Wiki page | Source entry points | Important symbols / types | Focused tests | Minimal validation | +| --- | --- | --- | --- | --- | --- | +| Add or change a trace-link pipeline / request payload | [Domain model](domain.md), [Workflows](workflows.md) | `src/util/ArdocoApi.tsx` | `TraceLinkTypes` (`src/components/dataTypes/TraceLinkTypes.tsx`), pipeline validation | none (build-only) | `npm run build` | +| Change upload wizard steps or validation | [Workflows](workflows.md) | `src/components/multiStepForm/MultiStepFormNewProject.tsx`, `src/components/multiStepForm/FormValidation.tsx` | `ProjectUploadContext` (`src/contexts/ProjectUploadContext.tsx`) | none | `npm run build && npm run lint` | +| Change result polling / result lifecycle | [Workflows](workflows.md), [Architecture](architecture.md) | `src/app/view/[id]/page.tsx` | result status (`OK` accepted state), `NavigationContext` | none | `npm run build` | +| Add or modify a result viewer panel | [Architecture](architecture.md) | `src/components/traceLinksResultViewer/ResultDisplay.tsx`, `views/*` | `ViewProps` (`views/ViewProps.tsx`), highlight contexts | none | `npm run build` | +| Change client state (API address, upload, highlight) | [Architecture](architecture.md) | `src/contexts/*.tsx` | `ApiAddressContext`, `ProjectUploadContext`, `Highlight*Context` | none | `npm run build` | +| Change routing or page shell | [Architecture](architecture.md) | `src/app/layout.tsx`, `src/app/page.tsx`, `next.config.ts` | `pageExtensions`, `output: 'standalone'` | none | `npm run build` | +| Change build, lint, Docker, or CI | [Operations](operations.md) | `package.json`, `.github/workflows/verify.yml`, `Dockerfile` | npm scripts (`dev`, `build`, `lint`) | `verify.yml` build job | `npm run build` | + ## Repository shape - `src/app/` holds the Next.js app router pages. diff --git a/openwiki/workflows.md b/openwiki/workflows.md index b56a993..63d5aad 100644 --- a/openwiki/workflows.md +++ b/openwiki/workflows.md @@ -1,3 +1,10 @@ +--- +type: "Reference" +title: "Workflows" +description: "TraceView user journeys from landing page through project setup, backend submission, result polling, and multi-panel result exploration." +tags: [workflows, user-journey, submission, result-polling] +--- + # Workflows This repository's user journeys are centered on one main flow: create a project, upload the relevant artifacts, submit to ARDoCo, and inspect the results.