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

[DOCS]: We really need documentation #89

Open
albertocottica opened this issue Aug 4, 2023 · 1 comment
Open

[DOCS]: We really need documentation #89

albertocottica opened this issue Aug 4, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@albertocottica
Copy link

What areas do you propose needs improvement?

An obvious area is the composition of the query: are boolean operators supported? What is the syntax? What about exact strings, such as "collective intelligence"? Case sensitivity?

Where is the current state of the documentation?

I can find none at all

What are your suggestions?

Invest heavily in documentation. The feeling of working with undocumented software is disempowering, and it does not look like we have the resources to implement self-evident interfaces. IMHO it would be overkill, even if we could.

Add why this is beneficial.

Self-evident.

Add any other relevant details

No response
@albertocottica albertocottica added the documentation Improvements or additions to documentation label Aug 4, 2023
@this-pama
Copy link
Contributor

Documentation stated and can be accessed here https://github.com/UNDP-Accelerator-Labs/platform/wiki

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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@albertocottica @this-pama