🚀 Feature: Documentation #74

Closed
opened 2026-02-04 17:05:25 +03:00 by OVERLORD · 5 comments
Owner

Originally created by @levino on GitHub (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.

Originally created by @levino on GitHub (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.
OVERLORD added the feature label 2026-02-04 17:05:25 +03:00
Author
Owner

@stonith404 commented on GitHub (Dec 31, 2024):

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.

@stonith404 commented on GitHub (Dec 31, 2024): 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.
Author
Owner

@levino commented on GitHub (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.

@levino commented on GitHub (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.
Author
Owner

@stonith404 commented on GitHub (Jan 2, 2025):

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.

@stonith404 commented on GitHub (Jan 2, 2025): 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](https://github.com/stonith404/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.
Author
Owner

@kmendell commented on GitHub (Jan 22, 2025):

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

@kmendell commented on GitHub (Jan 22, 2025): Initial Documentation has been setup here: [stonith404.github.io/pocket-id](https://stonith404.github.io/pocket-id)
Author
Owner

@levino commented on GitHub (Jan 22, 2025):

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

@levino commented on GitHub (Jan 22, 2025): Very nice! Great work. I would say, issue has been resolved, has it not?
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/pocket-id#74