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

Update Siren Documentation #137

Closed
8 tasks
mabdh opened this issue Oct 17, 2022 · 0 comments · Fixed by #138
Closed
8 tasks

Update Siren Documentation #137

mabdh opened this issue Oct 17, 2022 · 0 comments · Fixed by #138
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@mabdh
Copy link
Member

mabdh commented Oct 17, 2022

  • Add a glossary section to introduce all key terms.
  • Update concept section to explain all keys terms in details.
  • Update guide flow wth an example journey. Check buf guide for reference.
  • Complete reference to other things should move to references. Check Buf for reference.
  • Update guides to accommodate CLI and API using docusaurus tabs.
  • Create a full CLI reference and move it to reference section.
  • Create a full API reference and move it to reference section.
  • Remove empty pages. Merge monitoring, deployment and troubleshooting in deployment guide only.
@mabdh mabdh added the documentation Improvements or additions to documentation label Oct 17, 2022
@mabdh mabdh self-assigned this Oct 17, 2022
@mabdh mabdh linked a pull request Oct 18, 2022 that will close this issue
8 tasks
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

Successfully merging a pull request may close this issue.

1 participant