-
Notifications
You must be signed in to change notification settings - Fork 319
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
wip: implement jj docs
command
#3130
base: main
Are you sure you want to change the base?
Conversation
e9c1ab6
to
b41ad77
Compare
|
|
So this is separate from a man page or extended help topics? |
That's right. The idea is that the user can just read any of |
Both Git and Breezy have a lot of info accessible as |
Correct. Part of the problem there is that, as Ilya noted in #1294, I'm also hesitant to touch Unifying them would be good, I think, but I don't see a clear and easy way to do that right now and in the long run maybe |
For the record (though it's not totally relevant to this ticket), I think probably the best way to do this in the really long run would be to move almost all of the command definitions out of |
5dfba81
to
4ba36fc
Compare
0fcf467
to
5c5c573
Compare
75bffba
to
927005e
Compare
6cc1567
to
67d7108
Compare
67d7108
to
095da99
Compare
095da99
to
99f713a
Compare
99f713a
to
d551fb7
Compare
36dd0da
to
492025a
Compare
492025a
to
0e8b6c7
Compare
Signed-off-by: Austin Seipp <[email protected]>
Signed-off-by: Austin Seipp <[email protected]>
0e8b6c7
to
c4870e4
Compare
This is a rudimentary approach to embedding docs in the binary. It uses
termimad
to render markdown into the terminal. It still needs a lot of work, but something likejj docs FAQ
can in fact work right now.Getting this in a submittable state probably isn't too much work, but polishing the docs so they look good will take a bit of effort.
Closes #1294.
If applicable:
CHANGELOG.md