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

Markdown extension docs should include instructions to "include" the components #352

Open
goblinfactory opened this issue Sep 11, 2024 · 3 comments

Comments

@goblinfactory
Copy link
Contributor

goblinfactory commented Sep 11, 2024

If a markdown extension is created, but not included, you will get a runtime error (no build error) and it will be invisibly output to the chrome log;

Steps to reproduce

  1. create a simple component in new folder /components/foo.html
<div @name="foo">
<h1>hello</h1>
</div
  1. Edit any markdown file in a simple-blog starter project, and add [Foo] anywhere on the page.
  2. Browse to that page. Press F12, observe error in console.

I believe this is quite important because any new user following the getting started docs is quite likely to end up here at some point during playing with Nue for the first time.

More details in related issue #351

Alternative paths

  1. Simply mispelling an existing extension that has correctly been included, will also result in the same obtuse error; for example [MyAccordian] instead of [MyAccordion], which would be incredibly difficult for a human to spot the error with the focus of debugging efforts looking at MyAccordion code which could be totally fine.
@goblinfactory goblinfactory added improvement new feature New feature or request labels Sep 11, 2024
@goblinfactory goblinfactory changed the title Markdown exetension Documentation should include clear instructions to "include" the components Markdown exetension Documentation should include clear instructions and examples to "include" the components Sep 11, 2024
@goblinfactory goblinfactory changed the title Markdown exetension Documentation should include clear instructions and examples to "include" the components Markdown extension docs should include instructions to "include" the components Sep 11, 2024
@nobkd nobkd added docs and removed new feature New feature or request labels Sep 11, 2024
@nobkd
Copy link
Collaborator

nobkd commented Dec 10, 2024

@goblinfactory
Copy link
Contributor Author

@nobkd Best solution is always to have the application or service be self documenting. If there are any errors then a helpful error message that tells you what you did wrong, or what is needed to be done to correct the problem, would be far more beneficial. Some of kind xyz missing component error would be pretty self explanatory.

@nobkd
Copy link
Collaborator

nobkd commented Dec 10, 2024

I think that would probably be one of the goals of #351

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

No branches or pull requests

2 participants