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.

Sign up for GitHub

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

Write proper Readme files and documentation #56

Open
2 of 7 tasks
dresslerdemos opened this issue Jan 4, 2023 · 0 comments
Open
2 of 7 tasks

Write proper Readme files and documentation #56

dresslerdemos opened this issue Jan 4, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation quality improvement Enhancement of existing features
Milestone
1.0.0

Comments

@dresslerdemos
Copy link
Contributor

dresslerdemos commented Jan 4, 2023 •
edited by joorei
Loading

Readme pointers:

  • purpose
  • how to use
  • extendability
  • pitfalls: e.g. limitation of type checking
  • license(?)
  • explain internals like path salting, access depth and the prewritten conditions/functions
  • explain usage of classes like Drupal parser
@dresslerdemos dresslerdemos added documentation Improvements or additions to documentation quality improvement Enhancement of existing features labels Jan 4, 2023
@dresslerdemos dresslerdemos added this to the 1.0.0 milestone Apr 16, 2024
@joorei joorei mentioned this issue Jun 7, 2024
Closed
@joorei joorei pinned this issue Jun 7, 2024
@joorei joorei mentioned this issue Jun 9, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation quality improvement Enhancement of existing features
Projects
None yet
Milestone
1.0.0
Development

No branches or pull requests
1 participant
@dresslerdemos