Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Offline Manual #18691

Open
1 of 3 tasks
jansol opened this issue Oct 3, 2024 · 1 comment
Open
1 of 3 tasks

Offline Manual #18691

jansol opened this issue Oct 3, 2024 · 1 comment
Labels
documentation [core label] enhancement [core label]

Comments

@jansol
Copy link
Contributor

jansol commented Oct 3, 2024

Check for existing issues

  • Completed

Describe the feature

Now that we have changelogs displayed directly in Zed, it would be nice to also have the docs bundled and displayable directly in Zed as well. Since the docs already appear to be written in markdown, it should be relatively straightforward to share the code from the changelog view. Essentially:

  • Pack docs into the app bundle at build time (they live in the same repo so the version always matches).
    • It's probably better to just copy them into a resource directory in the bundle instead of packing them into the binary. That way they can also be viewed with external applications in case Zed fails to launch.
  • Add zed: open manual action to open the bundled docs in a rendered markdown view

If applicable, add mockups / screenshots to help present your vision of the feature

No response

@jansol jansol added admin read Pending admin review enhancement [core label] triage Maintainer needs to classify the issue labels Oct 3, 2024
@JosephTLyons JosephTLyons added documentation [core label] and removed triage Maintainer needs to classify the issue admin read Pending admin review labels Oct 3, 2024
@maxdeviant
Copy link
Member

Since the docs already appear to be written in markdown, it should be relatively straightforward to share the code from the changelog view. Essentially:

I don't think it's quite that simple, as the docs are all built for mdbook (along with some custom preprocessors), so they aren't going to show up exactly 1:1 when using a standard Markdown renderer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation [core label] enhancement [core label]
Projects
None yet
Development

No branches or pull requests

3 participants