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.

Sign up for GitHub

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

Jump to bottom

Add documentation on Wezterm plugins #6177

Open
alecthegeek opened this issue Sep 23, 2024 · 2 comments
Open

Add documentation on Wezterm plugins #6177

alecthegeek opened this issue Sep 23, 2024 · 2 comments
Labels
docs Primarily or only affects documentation

Comments

@alecthegeek
Copy link

What page or section of the docs have an issue?

Needs a new section?

Describe the issue

Wezterm plugins have no documentation. It would be useful to have some.

  1. End user Docs.

Initially we can use paraphrse the content of the original change at e4ae8a8

However we need to add more details on how to update plugins and discover where they are located.

  1. Developer Docs.

A more substantial section is also needed to explain how to setup a plugin development project.
@alecthegeek alecthegeek added the docs Primarily or only affects documentation label Sep 23, 2024
@wez
Copy link
Owner

wez commented Sep 23, 2024

If you'd like to make a start on this, the way to go about it is:

eg: Page("Plugins", "config/plugins.md"),

  • then create the file docs/config/plugins.md with the content.

Once you've added that entry to ci/generate-docs.py, and created the docs/config/plugins.md, you can then run the doc build locally:

$ ./ci/build-docs.sh serve

(docker is required to run that script)

That will build the docs (takes a few seconds), then run an http server and print out a URL that you can open in your browser and then navigate to your new page. As you make changes to doc files, the docs will be rebuilt and the browser will automatically reload.

@alecthegeek
Copy link
Author

Thanks @wez . I'll give it a burl

alecthegeek added a commit to alecthegeek/wezterm that referenced this issue Sep 24, 2024
@alecthegeek
Added new page to describe Plugins.
44750ad 
WIP for review

TODO:

1. Add a section to the reference for `wezterm.plugins`
2. Create a plugin starter project

wez#6177
@alecthegeek alecthegeek mentioned this issue Sep 24, 2024
Open
alecthegeek added a commit to alecthegeek/wezterm that referenced this issue Sep 25, 2024
@alecthegeek
Add reference material for plugin module
c46d99f 
Addresses wez#6177
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Primarily or only affects documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@alecthegeek @wez