Repository navigation
docs: report a bug or request a feature from the conversation - #123
Merged
Merged
Conversation
Describe /report and its Feedback Composer, that only the person's Create issue press files a report, the result states, Check again and Send again, what is and is never shared, and the person-only /feedback/reports routes, in English and Vietnamese. Refs #118 Refs digitopvn/clarkcant#510 Refs digitopvn/clarkcant#530
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Do not merge before digitopvn/clarkcant#530 merges.
Official docs (EN + VI) for reporting a bug or requesting a feature from the conversation.
Changes
docs/index.html,vi/docs/index.html:/reportin the slash command list, and a new section Report a bug or request a feature (#report). It covers the Feedback Composer, that only the person's own Create issue press files a report, the policy on that press, duplicate search, the result states, Check again, Send again and Send anyway, recheck after a restart,github_tokenand the manual link, what is and is never shared, and that handing a filed issue to Clark is not available yet.docs/api.html,vi/docs/api.html: new section Report a bug or request a feature (#product-reports) with the three/feedback/reportsroutes, the request shape, the publish intents, the statuses,409 NOTHING_SENT,409 NOT_INCONCLUSIVE,eligibility, and403 PERSON_ONLY.docs/mcp.html,vi/docs/mcp.html: the person-only note now says that filing a product report is refused on machine surfaces.Source of truth
Every claim was checked against
docs/open-interfaces(.vi).md"Product reports",packages/contracts/src/feedback.ts,apps/runtime/src/application/{slash-commands,product-feedback,feedback-github}.ts,packages/contracts/src/machine-surfaces.tsand the card strings inmessages-shell.tsat the head of digitopvn/clarkcant#530.Notes
intent: "send-anyway"(Send anyway) for a report whose outcome checking cannot settle. That is documented too.Verification
node scripts/prepare-site.mjs(build:static) copies the pages and writes the sitemap.pnpm verifyand browser suite run in the Blog checks workflow on this PR; these pages are static HTML that the typecheck and tests do not read.Refs #118
Refs digitopvn/clarkcant#510
Refs digitopvn/clarkcant#530