LisaFC / docsysite

Draft version of Docsy site and user guide. WIP!
Apache License 2.0
0 stars 2 forks source link

Getting Started is almost only install and update docsy #10

Open RichieEscarez opened 5 years ago

RichieEscarez commented 5 years ago

https://serene-roentgen-10fbaa.netlify.com/docs/getting-started/

I need to think about this more but I think in order for a user to be able to "get started" with Docsy, they would need to understand the Hugo requirements (ie folder and content structure, _index.md files, and frontmatter).

It feels very quickstart (ie first touch to success) right now and I think we should cover more concepts before it can be a "getting started".

In the content now, i think localization and search integration/enablement should be later in the process after we have established an understand of say the ridged folder structure and other Hugo requirements that Docsy is built off of.

Idea - Maybe two topics:

LisaFC commented 5 years ago

I'm in two minds about this, because yet again I want to avoid this site also becoming "the Hugo docs" and conflating Hugo and Docsy in the minds of our users (not least because then we end up getting Hugo issues that we can't deal with ourselves). In particular we don't want to end up duplicating information that might change from the Hugo docs. I can see the use for a sort of quick "Hugo primer" but it would have to be super-minimal.

LisaFC commented 5 years ago

So I've had a bit of a think and I suspect this might be something to do in the next iteration of the docs - as you say, the Getting Started is very much "quick start" before providing everything else as tasks, but if they copy the example site they will have all the hugo folders etc already (I'm assuming only a non-Hugo-newbie is going to try just using the theme) and should have enough info to get through it between the Hugo docs and our adding content section. For the next iteration, we could add a tutorials section and do something like an end to end tutorial?

I'm also going to add a quickie section at the top of the section on adding content just reminding/overview-ing them about Hugo folder structure (and linking to the Hugo docs again) and that should hopefully give some context for what follows.

RichieEscarez commented 5 years ago

My thought here was more along the lines of not so much copy "hugo steps" or content, but rather, come and use this theme because it will "get you started with all the various components of your site" (not just install a theme). So, instead of relying on the deep sea of docs in Hugo, we provide the basics at a really high level (am thinking really just the steps we already cover under "content and customization" but in a clear flow).

Otherwise, to me, the "getting started" title doesnt really meet my expectations and is more accurately "Installing" (ie install hugo, dependencies, and clone (or add submodules)).

That said, i agree we can tackle adding more detail and building this out for the next go around.

LisaFC commented 5 years ago

Going to park this for now.