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

Documentation Epic #60

Open
5 tasks
abhay-raizada opened this issue Nov 9, 2023 · 0 comments
Open
5 tasks

Documentation Epic #60

abhay-raizada opened this issue Nov 9, 2023 · 0 comments

Comments

@abhay-raizada
Copy link
Owner

abhay-raizada commented Nov 9, 2023

Things to be added for the documentation:

  • Readme.md for the repo - Should have a brief about the project setup, install instructions
  • Architecture.md - A doucment detailing how formstr interacts with the nostr protocol, how forms are created, read, what is the formstr specifcation.
  • Documentation:
    • How to create a form via the UI/SDK
    • How to fetch a form via UI/SDK
    • Form Filling and Validation Errors on UI/SDK

Feel free to reach out to @abhay-raizada for any clarifications

@abhay-raizada abhay-raizada changed the title Add a contributing.md Documentation Epic Apr 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant