aurelia / documentation

The documentation for Aurelia.
MIT License
105 stars 111 forks source link

display issue with basic binding example #372

Closed avrahamcool closed 5 years ago

avrahamcool commented 5 years ago

the documentation shows nicely in the github page.

image

but looks wrong in the actual documentation page.

image

maybe `foo${bar}baz${qux}quux` should become `foo\${bar}baz\${qux}quux`

how can we test the result of a change in the documentation, to see how it will render in the real documentation pages?

avrahamcool commented 5 years ago

same behavior a few paragraphs later. in github:

image

in result documentation page: image

3cp commented 5 years ago

PR pls :-)

avrahamcool commented 5 years ago

Id love to, but how can I test my changes? I need a way to transform the repo into pages the same way the documentation site does. (is it covered here somewhere?)

3cp commented 5 years ago

The doc is handled by https://github.com/aurelia/site-generator But I have not tried since @EisenbergEffect switched to centralised doc, I am not sure how to do it.

@EisenbergEffect could you add some instruction to readme?

EisenbergEffect commented 5 years ago

It's a bit tricky to test it out locally. I have a todo on my list to create a "sandbox" within this repo and instructions on how to run it to test. I'll try to get that in place soon. Will probably be a week or two since I'm traveling. If you want to submit a PR, I'm happy to test it out and fix it if it doesn't work. It should just be the addition of the backslashes that's required.

avrahamcool commented 5 years ago

I'm not sure if this was published or not.. but the documentation result is still broken.

if it was published, we need to find the right fix to apply.

EisenbergEffect commented 5 years ago

It’s not published yet. Should go out today or tomorrow.

Sent from my iPhone

On Jan 10, 2019, at 2:45 AM, Avraham Essoudry notifications@github.com wrote:

I'm not sure if this was published or not.. but the documentation result is still broken.

if it was published, we need to find the right fix to apply.

— You are receiving this because you modified the open/close state. Reply to this email directly, view it on GitHub, or mute the thread.

avrahamcool commented 5 years ago

@EisenbergEffect Sorry to bother you again with that. the site is still not showing properly. is the fix published?

EisenbergEffect commented 5 years ago

No apology necessary. I was on vacation and mis-accounted for what it would take me to catch up with work when I returned. So, this is on my list but I'm a bit behind. We've got several releases going out over the next few days. The docs will get updated with those changes and this one as part of that process. Thanks for your patience!

avrahamcool commented 5 years ago

just a quick follow up. I recently check the documentation site - and everything looks fine.

EisenbergEffect commented 5 years ago

We got things updated over the weekend :) We'll get the additional fix out in the next couple of days as well. Thanks for helping us out!