mirror of
https://github.com/pocket-id/pocket-id.git
synced 2025-12-09 22:52:58 +03:00
🚀 Feature: Documentation #443
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @levino on GitHub.
Feature description
You should write and host a simple documentation about the features, endpoints, capabilities, etc. Currently I cannot find any.
Pitch
It would probably make more people use the product if they know what to expect in regards to functionality.
@stonith404 commented on GitHub:
It would be great if you could set the documentation up :)
I would also suggest to use Docusaurus because we are using it in Pingvin Share too. I would add a documentation folder to the root of the repository containing Docusaurus.
Thank you, I'm looking forward to it.
@levino commented on GitHub:
Very nice! Great work. I would say, issue has been resolved, has it not?
@stonith404 commented on GitHub:
Yeah that's a good idea. Setting it up will take some time, but I’ll look into it as soon as I have some free time.
@kmendell commented on GitHub:
Initial Documentation has been setup here: stonith404.github.io/pocket-id
@levino commented on GitHub:
I can help and make a basic set up. Which solution would you like? Docusaurus is nice, I find and I know it well. Essentially, one just writes markdown. One could also just extend the markdown files in the docs folder for the time being. Docusaurus can render it as a standalone page nicely later with further ado.