You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maka.apache.org by "Colafornia (via GitHub)" <gi...@apache.org> on 2026/08/21 08:15:06 UTC
[I] feat(runtime): add shared Markdown guidance for main chat responses [maka]
Colafornia opened a new issue, #3392:
URL: https://github.com/apache/maka/issues/3392
## Problem
When users ask Maka for information with sources, main chat responses can show raw URLs on separate lines instead of named Markdown links. The overall structure also varies between models because the shared main chat prompt does not define a default response format.
The chat already renders GitHub-Flavored Markdown. The missing part is clear guidance for how models should use it. A general instruction such as “use Markdown” is not enough because raw URLs are also valid Markdown.
## Desired outcome
Add a small set of shared default rules for main chat responses:
- Use GitHub-Flavored Markdown when it improves readability.
- Keep simple answers simple. Do not force headings or lists.
- Use short headings and flat lists when they make longer answers easier to scan.
- Use fenced code blocks for multiline code and backticks for commands, paths, identifiers, and literal values.
- Use descriptive Markdown links for external sources when a reliable name is available.
- Keep a raw URL when the user requests it, when it must remain exact, when it appears in literal output, or when no reliable name is available.
- Follow a more specific format requested by the user or task.
These rules should be the same across models and providers. They should remain stable across turns and should not change response content or link safety behavior.
Focused coverage should verify that the guidance appears once in main chat prompts. Representative model checks should cover a descriptive link, a requested raw URL, literal command output, and a simple one-line answer.
## Alternatives or workarounds
Users can request a format in each conversation or add project instructions. This is repetitive and does not provide a consistent product default.
A single “use Markdown” instruction is shorter, but it does not solve the raw-link problem or prevent unnecessary structure.
Rewriting raw URLs after generation is not suitable. The display layer cannot reliably infer link names and could change code, logs, or exact output.
## Non-goals
- Adding a full response style guide.
- Adding different format rules for each provider.
- Rewriting model output after generation.
- Replacing free-form responses with JSON or another structured protocol.
- Changing the existing link safety policy.
## AI use
Codex drafted this issue from a read-only review of Maka’s main chat prompt and Markdown response behavior.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@maka.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@maka.apache.org
For additional commands, e-mail: commits-help@maka.apache.org
Re: [I] feat(runtime): add shared Markdown guidance for main chat responses [maka]
Posted by "Astro-Han (via GitHub)" <gi...@apache.org>.
Astro-Han closed issue #3392: feat(runtime): add shared Markdown guidance for main chat responses
URL: https://github.com/apache/maka/issues/3392
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@maka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@maka.apache.org
For additional commands, e-mail: commits-help@maka.apache.org
Re: [I] feat(runtime): add shared Markdown guidance for main chat responses [maka]
Posted by "Colafornia (via GitHub)" <gi...@apache.org>.
Colafornia commented on issue #3392:
URL: https://github.com/apache/maka/issues/3392#issuecomment-5367358513
I have started working on this and plan to open a PR.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@maka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@maka.apache.org
For additional commands, e-mail: commits-help@maka.apache.org