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

Rearrange, update, extend docs #4

Closed
Technologicat opened this issue Oct 17, 2020 · 3 comments
Closed

Rearrange, update, extend docs #4

Technologicat opened this issue Oct 17, 2020 · 3 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@Technologicat
Copy link
Owner

Technologicat commented Oct 17, 2020

  • In the README, have a quick overview.
  • Have the main level of detailed docs in a separate file.
    • Keep the separate docs for quasiquotes, REPL.
    • The walker docs could go into the main detailed doc, it's just one class.
  • Move all docs except README to a doc/ subfolder.
  • Add more code examples.
    • Show how to use step_expansion, and example output. Important feature.
  • Write a separate doc for the dialect subsystem to help discoverability. Material already exists in docstrings.
  • Write a short what can I do with macros? section for new users.
@Technologicat Technologicat added the documentation Improvements or additions to documentation label Oct 17, 2020
@Technologicat Technologicat added this to the 3.0.0 milestone Oct 17, 2020
@Technologicat Technologicat changed the title Rearrange docs Rearrange, update, extend docs Oct 17, 2020
@Technologicat Technologicat modified the milestones: 3.0.0, 3.1.0 Nov 12, 2020
@Technologicat
Copy link
Owner Author

Mostly done now already for 3.0.0. Remaining TODOs:

  • In the README, have a quick overview.
  • Have the main level of detailed docs in a separate file.
  • Add more code examples.
    • Show how to use step_expansion, and example output (colors and all). Important feature.

@Technologicat
Copy link
Owner Author

README separation finished in 421996d.

Now just needs more examples. Maybe actually leaving that until 3.1.0.

@Technologicat Technologicat changed the title Rearrange, update, extend docs Add more examples to docs Nov 26, 2020
@Technologicat Technologicat changed the title Add more examples to docs Rearrange, update, extend docs Nov 27, 2020
@Technologicat
Copy link
Owner Author

Since the rest of this is done, moved the needs more examples item to a new issue, #14.

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