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

docs: Add "Writing your own prompt" doc #9841

Merged
merged 6 commits into from Jun 20, 2023
Merged

Conversation

faho
Copy link
Member

@faho faho commented Jun 10, 2023

Description

We have reasonable "reference" style documentation, but we kind of lack tutorials, so it's hard for people to even find out how to approach something.

So this attempts to rectify it by giving a simple example on how to write your own prompt.

@faho faho added this to the fish 3.7.0 milestone Jun 10, 2023
Copy link
Member

@zanchey zanchey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a great idea. I've got a mixture of feedback in this review, much of which I admit is my own style rather than the one true way of writing documentation.

doc_src/prompt.rst Show resolved Hide resolved
doc_src/prompt.rst Outdated Show resolved Hide resolved
doc_src/prompt.rst Outdated Show resolved Hide resolved
doc_src/prompt.rst Outdated Show resolved Hide resolved
doc_src/prompt.rst Outdated Show resolved Hide resolved
doc_src/prompt.rst Outdated Show resolved Hide resolved
doc_src/prompt.rst Outdated Show resolved Hide resolved
doc_src/prompt.rst Outdated Show resolved Hide resolved
doc_src/prompt.rst Outdated Show resolved Hide resolved
doc_src/prompt.rst Outdated Show resolved Hide resolved
@faho faho merged commit c385027 into fish-shell:master Jun 20, 2023
7 checks passed
@faho
Copy link
Member Author

faho commented Jun 20, 2023

Alright I've merged this now so it's easier to work on.

@faho faho deleted the custo-prompt-doc branch June 20, 2023 17:43
@faho faho modified the milestones: fish next-3.x, fish 3.7.0 Oct 9, 2023
zanchey pushed a commit that referenced this pull request Dec 25, 2023
* docs: Add "Writing your own prompt" doc

* Remove a space from the "output"

* some teensy adjustments

* Address feedback

* envvar one more PWD

* More html warning

(cherry picked from commit c385027)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants