Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions openwiki/.last-update.json
Original file line number Diff line number Diff line change
@@ -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"
}
7 changes: 7 additions & 0 deletions openwiki/architecture.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
7 changes: 7 additions & 0 deletions openwiki/domain.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
11 changes: 11 additions & 0 deletions openwiki/index.md
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 7 additions & 0 deletions openwiki/operations.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
19 changes: 19 additions & 0 deletions openwiki/quickstart.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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.
Expand Down
7 changes: 7 additions & 0 deletions openwiki/workflows.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down