decaporg / decap-cms

A Git-based CMS for Static Site Generators
https://decapcms.org
MIT License
17.67k stars 3.03k forks source link

Documentation: split up Add To Your Site into standalones #7051

Closed privatemaker closed 5 months ago

privatemaker commented 5 months ago

There are some pages in the documentation that are rather long in the current information architecture and file management, the most important one is:

The current #anchor style long page has some negative user-experience aspects:

  1. When loading the page via external link or manually loading these pages in browsers address bar the user lands on the page and the scrolling action starts.

decap-docs-page-title-linking

  1. When clicking on the leftbar TOC the page scrolls and properly shows the title. However, the scrolling is rather time intensive and distracting compared to a normal page load, as well as losing the entire leftbar navigation above the top of screen which is disorienting.

decap-docs-page-title-clicking

  1. These sections are semantically different (and important enough) I think that warrants it's own pages.

I propose migrating each of the Add To Your Site sections to their own pages

martinjagodic commented 5 months ago

@privatemaker this is a really good point. Also, the authentication section needs an update to include other options besides Netlify. I would do the rewrite as another PR. Would you take over the file reorg?

privatemaker commented 5 months ago

@martinjagodic yah i'm up for doing this. I will start a new PR once the Beta Features are done being merged.