X Tutup
The Wayback Machine - https://web.archive.org/web/20201206195400/https://github.com/sharkdp/fd/issues/695
Skip to content

/ fd

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

Jump to bottom

Documentation improvements #695

Open
sharkdp opened this issue Dec 1, 2020 · 2 comments
Open

Documentation improvements #695

sharkdp opened this issue Dec 1, 2020 · 2 comments
Labels
documentation good first issue help wanted

Comments

@sharkdp
Copy link
Owner

@sharkdp sharkdp commented Dec 1, 2020 •
edited

It's always a good idea to work on documentation. I think it would also be good to restructure the README:

  • Add a quick link section at the top of the readme (see https://github.com/sharkdp/bat)
  • Extend the tutorial (rename "How to use"?)
  • Move the "Parallel command execution" section inside the "How to use" section). See also: #605
  • Move "Installation" section below the "How to use" section
  • …

There are a few open issues labeled with documentation:

  • How to search for files based on a "whole-word" name #692
  • Bug: fixed string '- -' interpreted as flag/option #684
  • Can not find file without extension #673
  • Exclude not working: -E arg #661
  • '--fixed-strings=$STRING' is a substring match. Therefore a '--exact' option is necessary to not always match everything containing the STRING #627
  • Improve the '--exec' help text #605
  • --ignore-file and subdirs #374
  • Documentation and differentiation of --no-ignore-vcs and --no-ignore #354
@sharkdp sharkdp pinned this issue Dec 1, 2020
@tstewart-writer
Copy link

@tstewart-writer tstewart-writer commented Dec 6, 2020

I'd be happy to work on the documentation. I can start with the changes to the README, then see what else I can do.
@sharkdp
Copy link
Owner Author

@sharkdp sharkdp commented Dec 6, 2020

Sounds great. Several smaller PRs would be appreciated!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation good first issue help wanted
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
@sharkdp @tstewart-writer
You can’t perform that action at this time.
X Tutup