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

Feedback for “Custom Templates” #1824

Open
cliffvick opened this issue Mar 14, 2023 · 2 comments
Open

Feedback for “Custom Templates” #1824

cliffvick opened this issue Mar 14, 2023 · 2 comments

Comments

@cliffvick
Copy link

cliffvick commented Mar 14, 2023

“ After editing your .stencil or config.stencil.json files (if you are using Stencil V3.1 release or later), you must restart the Stencil app to view your changes locally. To restart stencil, type stencil start at a command prompt, and append the appropriate switches for your workflow, for example: stencil start -e -n.”

This tells me that “AFTER” I’ve edited my config file, but it doesn’t explain in any way (nor does it provide a link) for how I’m supposed to edit the config file. This is yet another example of the documentation author (or authors) assuming that the reader knows something that we don’t know yet. It shouldn’t be a problem for the author(s) to include links to documentation/explanation of what is contained in the documentation. This makes it incredibly frustrating to try to learn and understand how to create/modify themes and just generally understand Stencil and how Big Commerce works.

I attempted to find additional documentation for how I’m supposed to modify the config files when creating custom templates, so I searched for config.stencil.json in your stencil documentation search, and the only thing returned was config.json: https://developer.bigcommerce.com/theme-objects/config-json1st and then something about widgets (which wasn’t relevant). the link for `config.json wasn’t helpful either. I could not find anything that explained what I need to change in the config.stencil.json file when creating a custom template.

I took a look at the config.stencil.json file and there is a JSON object (“customLayouts”) that I’m assuming is the thing that I need to modify, but I have absolutely no idea what I’m supposed to put in the slots provided.

@cliffvick
Copy link
Author

Ok, now that I’ve read the section a little closer I found what I was looking for. So, ignore this issue.

Although, I would suggest that, even though I found what I was looking for, it was spread out throughout that page, and it would have been so much better if the explanation of the config.stencil.json file were described and explained in one place.

@cliffvick
Copy link
Author

Sorry, back again - I ran into another issue on this page that reverses my reversal of this issue and I’m reopening it for the same reason:

“ In this section, populate each key with a URL to create a mapping. For example, if you have a custom product template named alternate-product.html, and you want to view that template locally at http://localhost:3000/test-url/ (opens in a new tab), you need to populate the product key as shown in the following example:
Populate product key”

It seems like that “Populate product key” is supposed to be a link that explains how to do that.

Additionally, in the next 2 sections (“Expanding Mapping Example” and “Mapping Multiple URLs”) have the exact same problem.

@cliffvick cliffvick reopened this Mar 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant