olson-sean-k / wax

Opinionated and portable globs that can be matched against paths and directory trees.
https://glob.guide
MIT License
115 stars 10 forks source link

Create a website for documentation. #50

Open olson-sean-k opened 1 year ago

olson-sean-k commented 1 year ago

The wax README is much too long and currently provides the only detailed documentation for glob expression syntax. I imagine that the most common way to figure out how to compose a glob expression today is to browse to the repository page on GitHub. This is a bit awkward and quite noisy, I think, especially from the perspective of someone using some software that incidentally uses wax for globbing.

I've used mkdocs to create a website for plexus at plexus.rs and I'm mostly happy with the results. I think soemthing similar for wax could work and should include detailed documentation and examples of glob expression syntax without too much clutter. Ideally, there should be a good landing page for scenarios like using a CLI tool and following a link to learn more about how to write a glob to match some files.

I think the README needs some work and should only briefly mention what glob expression support without going into too much detail. Other technical details should also be moved into a documentation website too.

olson-sean-k commented 12 months ago

It needs a lot of work, but I've got a website running on GitHub Pages at https://glob.guide. At time of writing, the bulk of the syntax documentation from the README in this repository has been copied to https://glob.guide/user-guide/syntax. For the purposes of this issue, I'd like to:

  1. [x] Get the glob syntax documentation on https://glob.guide into an acceptable state and decide on a (stable) URL.
  2. [x] Link to https://glob.guide in the repository information on GitHub and in the README.
  3. [ ] Link to https://glob.guide in the crate API documentation.
  4. [ ] Remove detailed syntax documentation from the README.