fix!(docs): updates readme with better admonitions - #47
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates documentation rendering for GitHub-hosted AsciiDoc and adjusts the container image’s default execution behavior so runtime arguments replace the default command rather than being appended to an entrypoint.
Changes:
- Add
env-github-conditional admonition caption attributes inReadme.adocfor improved GitHub rendering. - Replace the container
ENTRYPOINTwithCMD(and document the rationale) to makedocker/podman run image <args>behave as intended.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| Readme.adoc | Adds GitHub-specific admonition caption overrides for better admonition rendering on GitHub. |
| oci/Containerfile | Switches from ENTRYPOINT to CMD and documents why, to ensure runtime args replace the default command. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+32
to
+38
| # CMD, not ENTRYPOINT: `docker/podman run image <args>` appends <args> | ||
| # after an ENTRYPOINT rather than replacing it, so `run image lcls` was | ||
| # actually executing `lc lcls` - never reaching the lcls wrapper script | ||
| # at all. CMD gets fully replaced by any run-time args instead, so | ||
| # `run image` (no args) still boots the daemon (LINEAR_CLI_DAEMON=true | ||
| # makes lc itself become the daemon regardless of argv) and | ||
| # `run image lcls`/`run image lc issue list` run exactly that command. |
Comment on lines
+9
to
+13
| ifdef::env-github[] | ||
| :tip-caption: :bulb: | ||
| :note-caption: :information_source: | ||
| :important-caption: :heavy_exclamation_mark: | ||
| :caution-caption: :fire: |
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.
No description provided.