metalsmith.io icon indicating copy to clipboard operation
metalsmith.io copied to clipboard

DOCS on navbar links to Welcome section

Open cyanxiao opened this issue 2 years ago • 4 comments

Don't know whether this is on purpose or not - DOCS button links to https://metalsmith.io/#welcome while there exists a page for docs (https://metalsmith.io/docs). Besides, Get Started button also directing to https://metalsmith.io/#welcome makes DOCS a little redundant if it actually represents https://metalsmith.io/#welcome.

cyanxiao avatar Jun 27 '22 09:06 cyanxiao

Half a year ago this site was single-page and I've been gradually updating it. It is meant to redirect to the dedicated docs page in the future, that's one of those works-in-progress, I wasn't even sure anyone would find https://metalsmith.io/docs. But this particular job is quite time-consuming, because:

  • The "old docs" under #welcome must be removed
  • New content must fill the homepage (a "featured" slider, a "starters" section)
  • The new docs must be on par or better than the old docs. I haven't had any feedback on this so far, so feel free to add.

This will probably take me 3-4 days so I need holiday time for that. Thank you for the reminder, now this is documented & more visible as a GH issue

webketje avatar Jun 27 '22 23:06 webketje

@webketje Thanks for your explanation & effort! IMO the new doc is clearer and has a flat learning curve.

cyanxiao avatar Jun 28 '22 15:06 cyanxiao

If you would like to get (slightly) more involved, there is a GH team"discussion board" at https://github.com/orgs/metalsmith/teams/ideators I can invite you to (no strings attached, it's just reading & providing feedback on ideas & plans that aren't ready for publication yet) & ofc always welcome at https://gitter.im/metalsmith/community

I'm open to changing the DOCS link to point to the new docs (hope I get some feedback from there in the coming 2 weeks). For ex I did a proofread of "Writing plugins" yesterday and saw 5-some spelling mistakes

webketje avatar Jun 29 '22 11:06 webketje

@webketje Sure, I'd like to join the discussion board.

cyanxiao avatar Jun 29 '22 11:06 cyanxiao

Fixed in the meantime

webketje avatar May 25 '23 00:05 webketje