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

Write documentation for app and controller configuration #14

Open
djbpitt opened this issue Dec 13, 2021 · 0 comments
Open

Write documentation for app and controller configuration #14

djbpitt opened this issue Dec 13, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@djbpitt
Copy link
Member

djbpitt commented Dec 13, 2021

Your to-do

1a. Review existing documentation and create guiding goals/anti-goals to inform approach and style

  1. Write documentation for general app set-up
  2. Write documentation for controller configuration within app
  3. Collect links to XQuery and eXist-db external documentation

Issues you may encounter

  1. Older documentation is too long and wordy, with too many steps, each of which is too long. Some of the information may also no longer be current.
  2. Need to figure out how to test and debug controller configuration.

Additional context

@djbpitt djbpitt added the documentation Improvements or additions to documentation label Dec 13, 2021
@djbpitt djbpitt self-assigned this Dec 13, 2021
@gabikeane gabikeane assigned gabikeane and unassigned djbpitt Feb 3, 2022
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

2 participants