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: Move completion tutorial out into its own document #6709

Merged
merged 1 commit into from Mar 6, 2020

Conversation

faho
Copy link
Member

@faho faho commented Mar 4, 2020

This is useful, but it's a rather large thing that's uninteresting to
many users. So we put it into its own (top-level, for now) document.

The reason for this PR is that we have a note somewhere saying that we shouldn't have more separate documents (might have been in the old doxygen docs somewhere), but to be quite honest I disagree with this.

And not just for this one case, tho this is egregious, but also potentially for more things. Not that I'd want one document per "chapter", but the 7 docs we have after this change (and that's counting the license and design docs) are too few.

TODOs:

  • Changes to fish usage are reflected in user documentation/manpages.
  • [N/A] Tests have been added for regressions fixed
  • User-visible changes noted in CHANGELOG.md

This is useful, but it's a rather large thing that's uninteresting to
many users. So we put it into its own (top-level, for now) document.
@faho faho added enhancement docs An issue/PR that touches or should touch the docs labels Mar 4, 2020
@faho faho added this to the fish 3.2.0 milestone Mar 4, 2020
@ridiculousfish
Copy link
Member

I very much agree with this direction, the index file is a wall of text and we should break it up. LGTM!

@faho faho merged commit 17f989e into fish-shell:master Mar 6, 2020
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 4, 2020
@faho faho deleted the completions-own-doc branch September 23, 2021 09:41
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs An issue/PR that touches or should touch the docs enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants