mirror of
https://github.com/morluto/rea.git
synced 2026-11-10 00:36:35 +00:00
a67525cdf1
* docs: organize canonical documentation layout (URGENTE) Group all existing authored guides by domain and ownership, expose complete navigation, and preserve their public routes. Update physical path consumers and release configuration while retaining historical records. Document domain-based specs and ADR slugs without global numbering. Co-Authored-By: Codex <noreply@openai.com> * fix(docs): honor home layout in all-page route verification * style: format reviewed source changes * fix(docs): preserve routes and navigation cache inputs * fix: repair the static-check failures on the default branch (#2895) * fix: repair the static-check failures on the default branch The default branch fails its own required `Static checks` job three ways, so every pull request reports that job as failed regardless of its own change. - `npm run format:check` reports `src/domain/functionComparison.test.ts` and `src/ida/IdaOperationRunner.ts`. - `npm run lint` reports a duplicate `import { join } from "node:path"` in `tests/boundary/mcp/ghidraInventoryMcp.test.ts` (lines 4 and 17). - `npm run typecheck` reports `format: "devin"` missing from the client format union in `src/application/SupportedClients.ts`, and an unchecked index in `tests/boundary/cli/clientProfileLifecycle.test.ts`, whose pair array is inferred as `string[][]`. Apply the pinned formatter, drop the duplicate import, list the `"devin"` format that its own definition already uses, and mark the pair array `as const`. Validation: `npm run check:fast` and `npm run format:check` pass. * fix(setup): keep Devin on the JSON configuration dialect --------- Co-authored-by: 吴佳浩 <wujiahao@supremind.com> Co-authored-by: morluto <76467478+morluto@users.noreply.github.com> * fix(docs): update links after guide relocation * docs: correct verified documentation route counts * fix(docs): update browser capture guide link after move (#2820) Refresh gettext protected-link comments alongside the authored href. Co-authored-by: Codex <noreply@openai.com> * fix(docs): include http3 lab in stable routes * fix(docs): preserve historical release evidence and links * fix(ghidra): restore Windows verifier identity import * docs(wakaru): preserve pinned upstream policy link * docs(index): retain recently added guide links * docs(mcp): preserve parent retention clarification * fix(cli): preserve standalone import guidance * fix(test): preserve translated guide link drift coverage --------- Co-authored-by: Matheus Breguêz <matbrgz@gmail.com> Co-authored-by: Codex <noreply@openai.com> Co-authored-by: morluto <17176810+morluto@users.noreply.github.com> Co-authored-by: 吴佳浩Alben <35291372+XiaoBinGan@users.noreply.github.com> Co-authored-by: 吴佳浩 <wujiahao@supremind.com>
63 lines
2.2 KiB
YAML
63 lines
2.2 KiB
YAML
name: Documentation
|
|
description: Report unclear, missing, or incorrect REA documentation
|
|
title: "[Docs] "
|
|
labels:
|
|
- documentation
|
|
- triage
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Report one documentation problem with the exact location and the smallest
|
|
useful supporting passage, example, or result. Keep answers concise.
|
|
If something is unknown, write `NOT_ENOUGH_INFO` and explain what is missing.
|
|
|
|
- type: checkboxes
|
|
id: before-submitting
|
|
attributes:
|
|
label: Before submitting
|
|
options:
|
|
- label: I searched the existing issues for a related documentation report.
|
|
required: true
|
|
- label: I removed credentials, tokens, private paths, and sensitive target data.
|
|
required: true
|
|
|
|
- type: input
|
|
id: location
|
|
attributes:
|
|
label: Documentation location
|
|
description: Link the page, section, command, API, skill, or inline comment.
|
|
placeholder: README.md#quick-start or docs/reference/mcp-contracts.md
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: problem
|
|
attributes:
|
|
label: Problem
|
|
description: Quote or describe the current content, explain what is unclear, missing, outdated, or incorrect, and say how to observe the problem. State who is affected when known.
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: expected-content
|
|
attributes:
|
|
label: Expected content
|
|
description: Describe the accurate behavior or example that should be documented, with a reference when available. Label a proposed clarification or unknown behavior clearly.
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: evidence
|
|
attributes:
|
|
label: Supporting evidence
|
|
description: Include an exact passage, source reference, command output, provider documentation, or screenshot supporting the report. For missing or unclear guidance, point to the relevant section and explain the gap. If evidence is unavailable, write NOT_ENOUGH_INFO and explain what is missing.
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: additional-context
|
|
attributes:
|
|
label: Additional context
|
|
description: Include screenshots, affected translations, or related issues.
|