Conversation
|
coverage: 98.944%. remained the same — README into main |
thetic
force-pushed
the
README
branch
3 times, most recently
from
a977982 to
82e3117
Compare
These are generally implementation details.
Replace logo/hr with `# Mutiny` h1 (silences myst_parser heading warning),
drop redundant RST title from index.rst. Restore all Sphinx cross-references
from the original getting-started.rst using MyST role syntax: {c:macro},
{cpp:class}, {cpp:func}, {cmake:command}, {source}, {doc}. Replace bare
bracket paths with proper roles/directives. Restore missing
mutiny/test/Ordered.hpp header row and Examples table. Replace bracket
literalinclude placeholder with {literalinclude} directive.
MyST directives and roles do not render well on GitHub. Replace all
{c:macro}, {cpp:class}, {cpp:func}, {cmake:command}, {source}, and {doc}
roles with plain backtick code or standard markdown links. Replace
{literalinclude} with a link to the source file.
The README.md include approach introduced myst.xref_missing warnings for relative paths (examples/tests/*.cpp, docs/command-line-reference.rst) that MyST resolves relative to docs/ instead of the repo root. The relative-docs option only rewrites paths that start with its own value, so there is no clean way to adjust the base for all relative links. Replace the include with a plain RST intro and keep the same toctrees.
thetic
commented
Apr 12, 2026
thetic
commented
Apr 12, 2026
thetic
commented
Apr 12, 2026
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
2 participants
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.
Description
Move content from docs to README and integrate README with documentation build.
Related Issues
Fixes # (issue number)
Type of Change
Checklist
docs/for any user-facing changes.mu::tinynamespace,INCLUDED_MUTINY_guards,mutiny_C-prefix)..hand.c.cpp) is required for parity.CONTRIBUTING.mdfile to ensure compliance with architectural guidelines.