Ongoing Work to Improve Aurelia 1 Documentation

Hello Aurelians

We wanted to update you on some exciting work happening around Aurelia 1 documentation. As many of you know, while Aurelia 2 has been making great strides, there are still many companies actively maintaining and developing with Aurelia 1. These companies are hiring and training new developers, and having comprehensive, high-quality documentation is crucial for them.

To support this, we’ve been working on porting over the Aurelia 1 documentation into Gitbook, with a focus on improving and modernising the docs. Our goal is to bring the Aurelia 1 docs to the same high standard as the Aurelia 2 documentation, making it easier for developers to maintain their Aurelia 1 applications and onboard new team members effectively.

You can follow along with the progress on the ongoing work at the GitHub repo here: Aurelia v1 Documentation. We also have a staging site where you can preview the work-in-progress docs: Aurelia 1 Docs Staging Site. Please note that the docs are still a work in progress and are going through a final revision and editing process. While these are not the final versions, we wanted to give the community a chance to see what’s being worked on.

We appreciate your continued support and feedback as we work to make Aurelia 1 documentation as robust and helpful as possible.

15 Likes

Great initiative! Very much appreciated.

Still work in progress as you mention, is this something you as a team will take care of, or is help from the community appreciated as well?

1 Like

Community has always mattered to us. Without the community, we are nothing :heart: pull requests are always welcome.

2 Likes

this is great news.
keep on making aurelia great :slight_smile:

1 Like

This page https://aurelia-by-examples.netlify.app/ comes in very handy too. It shows many working examples of features I didn’t know, like au-portal attribute, scroll binding and <let>.
It would be nice to have such in the the docs.

2 Likes

Wow, this is so handy. Is there something similar for AU2?

2 Likes