Fix README docs rendering; drop internal spec links#36
Merged
Conversation
Wrap the badge table and hero image in @raw html comment fences (the PiccoloDocsTemplate pattern) so they render on both the GitHub README and the Documenter docs page. Move the hero image reference to repo-root assets/ (assets/circuit_to_pulse.png) so the path resolves in both README and generated index.md. Remove the amico/vault/specs links: broken on GitHub (not in repo) and internal-only.
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
1 participant
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.
Match the Legato README to the format used by the other public Piccolo repos.
What changed
@raw htmlcomment fences — wrap the badge<div><table>and the hero<p><img>in<!--\``@raw html-->/fences (thePiccoloDocsTemplatepattern, matching DirectTrajOpt.jl). On GitHub these are hidden comments and the HTML renders natively;generate_indexpromotes them to real```@raw html ` blocks so the Documenter docs page renders the badges and image instead of escaping the raw HTML. Previously the docs-page header was broken.assets/circuit_to_pulse.png(duplicated at repo root, mirroring every other repo) so the single relative path resolves both on GitHub (README at root) and in the generateddocs/src/index.md. Wasdocs/src/assets/…, which broke inindex.md.amico/vault/specs/…links — broken on GitHub (targets are not in the repo) and point at the internal vault. Kept the public Piccolo.jl link.Verified by simulating the
generate_indexregex: both the GitHub view and the generatedindex.mdrender correctly.