search

aurelia / documentation

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

Documentation Needs #181

Open plwalters opened 8 years ago

plwalters commented 8 years ago

Docs Plan

A Web Developer

EisenbergEffect commented 6 years ago

@avrahamcool This is very exciting. You've certainly identified an important missing piece from our docs. We apologize for the inconvenience and would absolutely love your help in improving this. Thank you for volunteering.

To make contribution easier, we've recently moved all our docs back to this repo. To add the new content, simply create a new Markdown file and add it under current/en-us/plugins. You'll need to name the file with a number, as this represents the ToC ordering. Once we merge the PR, we'll be able to publish it to the site shortly thereafter. That's all there is to it.

On animation in general, while we didn't have a doc article, we did have an old blog post which I recently thought I might update and transform into official docs. You may be able to use it to help you put together what you are working on. You can find it here: https://aurelia.io/blog/2015/07/17/animating-apps-with-aurelia-part-1

Do you have any further questions? Is there anything I can do to help you in this process?

avrahamcool commented 6 years ago

@EisenbergEffect I'm trying to create a little demo in codesandbox.io, to demonstrate the basics of animation between views.

I need to have some css in place. I didn't succeed in adding a regular css file and simply require-ing it in my template. in the meantime I created a regular component (.html) with a <style> tag in it, it works as expected. is there an other way to do this the right way?

EisenbergEffect commented 6 years ago

@avrahamcool CodeSandbox uses a custom, webpack-like but not webpack, bundler internally, so it can behave oddly sometimes. For CSS, I'd recommend just inlining it like you have above or you an create a CSS file in the public folder and just link it into the head of the index.html page. That's what we did for all our binding docs demos.

avrahamcool commented 6 years ago

@EisenbergEffect I've forked the documentation repo, and committed my changes there. but I don't feel like it's ready to be merged.

I'ts the first time I try to document something, and when I read it back - it feels very clunky (I jump between thing that I need to explain, and its not well organized). also: the github page is not rendered as the official docs will eventually be - so I'm hoping i didn't screw-up anything (as I don't have any way to test this, aside from comparing to other parts of the docs and try to mimic them)

I tried to copy the relevant parts of the blog post you have mentioned above, but he has a lot more details that I wanted to go to. I feel like I've barely touched the capabilities of the animation plugin - I just demonstrated a simple use case of what it can do.

so maybe someone on the core-team can pass on the documentation that I created and make it better? I added a working demo based on the TODO application from the aurelia home page - with all kinds of animations - feel free to make it better if you see fit.

EisenbergEffect commented 5 years ago

@avrahamcool If you want to go ahead and submit a pull request, I can take what you've done and polish it a bit and get it out in the next release.

avrahamcool commented 5 years ago

@EisenbergEffect done. I've created a PR with wip, but i wasn't sure if you can merge it, so I changed it - but it's still need to be polished.

thanks you for all your time and kind replies.

avrahamcool commented 5 years ago

animation: basic can be checked now :) (in the list above)