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

Adding a getting started doc page #745

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jparrill
Copy link

Added a new Getting Started page with the basics of how to bootstrap the main functionality.
This allow the product to lower the entry level barrier

@fmartingr
Copy link
Member

Hey @jparrill, thanks for the contribution.

Have you checked the usage#docker docs? Most of the content in this one is covered in there, maybe Getting Started is a better name for that part of the documentation?

Apart from that, I think you forgot to push the new screenshots.

@jparrill jparrill force-pushed the feat/getting-started branch from 39d797b to f430881 Compare September 30, 2023 18:54
@jparrill
Copy link
Author

jparrill commented Sep 30, 2023

Maybe it's better covered there, and a name change could help. From my PoV when I've checked the docs it was a bit difficult to just bootstrap the server with the parameters and then add the bookmarks.

As you mention, changing the name of the Docker usage and putting (maybe a refernce) in the README.md could help on the visibility. Do you want me to follow this path or do you preffer to have a separated Getting Started section with the most basic usage of the app? w/e for me is fine :).

PS: Added the screenshots, you were right xD
PS2: I would change the order in the elements of the Documentation bullets with the most common usage pattern like:

  • Install
  • Configuration
  • Usage
  • FAQ
  • blah

@fmartingr
Copy link
Member

Ummm, I would do a mix of what we have now. I believe that most of the content here can be divided into two sections:

  • Usage: Would contain how to interact with Shiori in its two forms: web server and CLI.
  • Getting started: is a way better name than Usage for newcomers, and most of the current content in Usage.md would apply here (installation). Then, depending on how the user wants to run it (CLI vs Server) we can link them to the proper usage anchor.

There is some work around thin over at #703, where I'm trying to restructure the documentation step by step.

What do you think?

@jparrill jparrill force-pushed the feat/getting-started branch from f430881 to 0d15a7a Compare October 3, 2023 20:12
@jparrill
Copy link
Author

jparrill commented Oct 3, 2023

I've done some changes based on your comment, could you please review @fmartingr when you have time?

@jparrill jparrill force-pushed the feat/getting-started branch from 0d15a7a to cd33556 Compare October 3, 2023 20:14
This allow the product to lower the entry level barrier

Signed-off-by: Juan Manuel Parrilla Madrid <[email protected]>
@jparrill jparrill force-pushed the feat/getting-started branch from cd33556 to 97f758b Compare October 3, 2023 20:17

<!-- /TOC -->

## Running Docker Container
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have been giving a thought and I believe is better to point the installation to the proper installation docs, so we don't have repeated documentation around. Hopefully we will maintain that properly and up to date and when the documentation site is up an ready it will be easy to navigate through sections. What do you think?

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

Successfully merging this pull request may close these issues.

2 participants