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

Create a website for documentation. #50

Open
olson-sean-k opened this issue Oct 12, 2023 · 1 comment
Open

Create a website for documentation. #50

olson-sean-k opened this issue Oct 12, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@olson-sean-k
Copy link
Owner

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 olson-sean-k added the documentation Improvements or additions to documentation label Oct 12, 2023
@olson-sean-k
Copy link
Owner Author

olson-sean-k commented Nov 16, 2023

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. Get the glob syntax documentation on https://glob.guide into an acceptable state and decide on a (stable) URL.
  2. 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant