Rework documentation #1024
Rework documentation #1024
Conversation
lua/telescope/config.lua
Outdated
| --TODO(conni2461): Why is this even configurable??? | ||
| append("prefilter_sorter", sorters.prefilter, [[ | ||
| This points to a wrapper sorter around the generic_sorter that is able | ||
| to do prefiltering. | ||
| Its usually used for lsp_*_symbols and lsp_*_diagnostics | ||
|
|
||
| Default: require("telescope.sorters").prefilter]] | ||
| ) |
There was a problem hiding this comment.
Still think this should be removed :)
- To specific
- There is no reason for the user to change it
- We only offer one sorter for prefilter
- If user doesn't want prefiter he can still pass in a different sorter to that lsp_* picker.
- Most likely also not used by any extension because we still miss documentation for sorter.lua (this will change in this pr) + documentation for this config value never existed in the first place
There was a problem hiding this comment.
There was a problem hiding this comment.
Hey @Conni2461, I added a bunch of comments here on the work you've pushed so far just for some grammar fixes and general re-wordings of different changes to the docs. Everything looks great so far! I'll be happy to take a much more thorough pass through the docs once we move this PR out of WIP and into a full review stage. But hopefully these are helpful for the moment. Let me know if you have any questions over my suggestions!
Conni2461
force-pushed
the
docs_rework
branch
3 times, most recently
from
274c5a5 to
047c4d5
Compare
Conni2461
force-pushed
the
docs_rework
branch
from
047c4d5 to
d90c065
Compare
There was a problem hiding this comment.
Change request is about consistency on upper and lower case wording. And planned scope of PR (keep it more simple to get feedback etc).
Overall nice to have less cluttered README and much better documentation.
Personally I prefer a special document for defaults with a toc in vimdoc, but that is up to you.
|
@Conni2461 feel free to ping me whenever you need another pair of eyes on the docs changes. Happy to help proofread if you need some assistance. Now that I've gotten more adjusted to my new day job I should have some time to help on Telescope again here :). I'm gonna try and get to a few docs updates that people have requested and I have pinned to the Projects board in the next couple of weeks sometime. |
|
@smithbm2316 Still working on it. I wanna add the missing opts to builtins and i also have a lot of wip stuff for wiki. Like i moved the FAQ stuff to it, so if people have a conflict with another plugin they easily can just add it their. Without opening PR, etc. I'll try to get it done in the next couple of days. Idk its kinda boring work so i wasnt doing that much 😆 mostly just talking finishing it and not finishing it 🤣 |
Conni2461
force-pushed
the
docs_rework
branch
2 times, most recently
from
7942779 to
ade4b35
Compare
Conni2461
force-pushed
the
docs_rework
branch
from
ade4b35 to
bc9ee56
Compare
|
This is somewhat ready for a review :) The only thing i still wanna do is a getting started in vim doc. Just a small getting started. nothing that exciting. But i am already doing open source for 5 hours today. And i need to leave. I try to do it tomorrow. So if anyone finds time to review this. This would be awesome :) |
Conni2461
force-pushed
the
docs_rework
branch
2 times, most recently
from
f3bde00 to
5122c7b
Compare
|
In terms of the README, it all looks good to me. Thanks! |
|
Note to myself: We should probably mention |
Conni2461
force-pushed
the
docs_rework
branch
from
5122c7b to
c2fcf35
Compare
|
I think i have done everything i wanted to do. |
There was a problem hiding this comment.
Overall, this looks really good!
Thanks @Conni2461 for all the hard work 🙂
A few very small comments, but otherwise happy to merge.
There was a problem hiding this comment.
LGTM, amazing work @Conni2461. We are one step closer to dominate the pickers industry 😆
|
I might merge this in 5 - 10 minutes, with two commits (so i dont squash it) because @TC72 did some good work here and i want to give him full credit for it. :) |
Conni2461
force-pushed
the
docs_rework
branch
2 times, most recently
from
62074b9 to
458b021
Compare
* Fixed some grammar and tried to simplify the technical wording * Fixed the mistake of calling `map` a table instead of a function * Removed line about passing display to display
Conni2461
force-pushed
the
docs_rework
branch
from
458b021 to
144d41e
Compare
|
Thanks to anyone who reviewed stuff :) Its definitely not perfect but hacktoberfest is coming and we need new typos that can be fixed 🤣 |
Ready for Review :)
Rework of readme and wiki (live) + more stuff for vimdoc.
Now that we have vimdocs it makes sense to move some of the more specific documentation in the readme to the vimdocs. That affects mostly setup defaults and other stuff.
vimdoc>READMEBasically we need a better introduction for new users.
Todo:
vimdoc. But we need to make that people can put configurations in the wiki, so i need to clean it up)
Close #506 (its clearer now that it is required to have ripgrep installed)
Close #806 (same)
Close #780 (document that it is a lua regex with lua documentation link)
Close #277 (this is mostly already done, after the documentation changes we can close it)
Close #596
Close #1197
Close #1204
CC @tami5 @smithbm2316 @rockerBOO
Shorthand to new rendered documents: