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

Create author documentation #196

Open
icaraps opened this issue Aug 28, 2023 · 3 comments
Open

Create author documentation #196

icaraps opened this issue Aug 28, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@icaraps
Copy link
Collaborator

icaraps commented Aug 28, 2023

We can create a couple of documents to cover each template, landing page with all blocks and their variation in the /drafts/examples folder.

To explain how templates or blocks work precisely eg hero (text-right) variations, we can use comments directly in the document.

@icaraps icaraps added the documentation Improvements or additions to documentation label Aug 28, 2023
@icaraps
Copy link
Collaborator Author

icaraps commented Sep 11, 2023

I propose to get familiar with the different templates we have built. For that, you can pick a link from https://github.com/headwirecom/helix-sportsmagazine#demo, go to the document and copy paste the content into a new document and finally publish the new document.

To avoid impacting the current site, you can create these new documents in the draft folder here :https://drive.google.com/drive/folders/1OgNUtvBAaF3h60t_qHKIEUGgtm4fu2Q7

Feel free to use the commenting system to add explanations on how things work.

@ehdatheadwire
Copy link

I created an examples folder under /drafts/ -- direct link: https://drive.google.com/drive/folders/1rxSStEK-BKGGEpR007K8cOiFeeOHZ7VM?usp=sharing

I'll create the examples using the linked demo templates and provide direct links here so we can collaborate.

@ehdatheadwire
Copy link

Initial template editing / testing is complete. Created a feedback document that can be viewed here: https://docs.google.com/document/d/1_fKzcIm_bc6ZUm0S6MKGXwlnINuzrnuf6IQTj6zDB7w/edit?usp=sharing

It's open to sharing/editing for all hw employees. All links are included in this doc, but for ease of access, here's the list:

Template Preview Live
Default Article https://main--helix-sportsmagazine--headwirecom.hlx.page/drafts/examples/default-article-copy-creation-test-ehd https://main--helix-sportsmagazine--headwirecom.hlx.page/drafts/examples/default-article-copy-creation-test-ehd
Gallery Listicle https://main--helix-sportsmagazine--headwirecom.hlx.page/drafts/examples/gallery-listicle-copy-creation-test-ehd https://main--helix-sportsmagazine--headwirecom.hlx.live/drafts/examples/gallery-listicle-copy-creation-test-ehd
Gallery https://main--helix-sportsmagazine--headwirecom.hlx.page/drafts/examples/gallery-copy-creation-test-ehd https://main--helix-sportsmagazine--headwirecom.hlx.live/drafts/examples/gallery-copy-creation-test-ehd
Product Listing https://main--helix-sportsmagazine--headwirecom.hlx.page/drafts/examples/product-listing-page-copy-creation-test-ehd https://main--helix-sportsmagazine--headwirecom.hlx.live/drafts/examples/product-listing-page-copy-creation-test-ehd
Open Article https://main--helix-sportsmagazine--headwirecom.hlx.page/drafts/examples/open-article-copy-creation-test-ehd https://main--helix-sportsmagazine--headwirecom.hlx.live/drafts/examples/open-article-copy-creation-test-ehd
Long Form Article https://main--helix-sportsmagazine--headwirecom.hlx.page/drafts/examples/long-form-article-copy-creation-test-ehd https://main--helix-sportsmagazine--headwirecom.hlx.page/drafts/examples/long-form-article-copy-creation-test-ehd
Full Bleed Article https://main--helix-sportsmagazine--headwirecom.hlx.page/drafts/examples/full-bleed-article-copy-creation-test-ehd https://main--helix-sportsmagazine--headwirecom.hlx.page/drafts/examples/full-bleed-article-copy-creation-test-ehd

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants