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

🚀 Feature: Documentation #88

Closed
levino opened this issue Dec 31, 2024 · 5 comments
Closed

🚀 Feature: Documentation #88

levino opened this issue Dec 31, 2024 · 5 comments
Labels
feature New feature or request

Comments

@levino
Copy link

levino commented Dec 31, 2024

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
Copy link
Owner

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.

@levino
Copy link
Author

levino commented Dec 31, 2024

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.

@stonith404
Copy link
Owner

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.

@kmendell
Copy link
Contributor

Initial Documentation has been setup here: stonith404.github.io/pocket-id

@levino
Copy link
Author

levino commented Jan 22, 2025

Very nice! Great work. I would say, issue has been resolved, has it not?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants