Codeinwp / neve

A fast, lightweight, AMP ready WordPress theme built with speed and usability in mind.
https://themeisle.com/themes/neve/
GNU General Public License v2.0
262 stars 84 forks source link

Documentation Link for Starter SItes #3956

Closed JohnPixle closed 12 months ago

JohnPixle commented 1 year ago

From now on, we are going to introduce a short documentation for each starter site, that will help users orient themselves when importing a site.

In terms of UIX, the link for this documentation article will be exposed at the end of the import process.

Screenshot 2023-04-24 at 12 41 31 PM

Figma

As Mihai pointed out in Slack:

this can be enabled via the TPC plugin, similarly how we do it for the page templates; and have the option for a link.

Screenshot 2023-04-24 at 12 47 51

📌 important! This banner below will display only to the starter sites that have a URL / Article. For Starter sites without a doc link defined, this should be hidden.

Let me know if you need any help / clarifications with this. Thanks!

JohnPixle commented 1 year ago

Just checking into the status of this one, it would be good to have this implemented at some point. Available for any clarifications or help if needed!

HardeepAsrani commented 1 year ago

Hey @JohnPixle,

Have you started working on the docs for starter sites yet? Or do you want this to be implemented first?

JohnPixle commented 1 year ago

@HardeepAsrani

The doc for the last Starter Site is completed. Starter Sites earlier than that will not have a documentation link, as there are no docs. Only the last one, and the future ones will do so.

For those starter sites that DO NOT have a doc/url added, the learn more notification should not be displayed. Screenshot 2023-06-01 at 11 50 06 AM

Helpscout Part

The actual content for the article of the podcast site is in Notion.

@AndreeaCristinaRadacina Can you help with this? Need to add the article in helpscout, in order to get the helpscout article url and direct the users there.

I believe it makes sense to include it (and future ones) in this category: https://docs.themeisle.com/category/1813-neve-starter-sites

AndreeaCristinaRadacina commented 1 year ago

@JohnPixle, thank you for the details! I will create an issue on the docs repo and transfer the doc in HS format. Keep in touch 🙏🏻

AndreeaCristinaRadacina commented 1 year ago

@JohnPixle, I created the doc - https://docs.themeisle.com/article/1867-getting-started-with-the-podcast-starter-site Added a few screenshots and a reference to Neve custom layouts doc. Also, to avoid confusion, I renamed the last section to Useful Resources, as we already have a related articles section.

Please, let me know what you think!

JohnPixle commented 1 year ago

Thank you Andreea, looking good!

cristian-ungureanu commented 1 year ago

Hey @HardeepAsrani, should we create tiny links ( rviv.ly ) for doc urls?

HardeepAsrani commented 1 year ago

@cristian-ungureanu The links are on our API end, so I think they can just be doc URLs. If we ever need to update them, we can do it them on the demo data exporter. What do you think?

cristian-ungureanu commented 1 year ago

Sounds good, @HardeepAsrani. Thank you!