diff --git a/docs/src/content/docs/architecture/structure.md b/docs/src/content/docs/architecture/structure.md index b81af90a..b770d373 100644 --- a/docs/src/content/docs/architecture/structure.md +++ b/docs/src/content/docs/architecture/structure.md @@ -1,6 +1,5 @@ --- -title: Architecture -description: A guide in my new Starlight docs site. +title: Folder structure --- ### Folders/Libs structure diff --git a/docs/src/content/docs/how-to-contribute/index.md b/docs/src/content/docs/how-to-contribute/index.md index 7cb0127d..97443274 100644 --- a/docs/src/content/docs/how-to-contribute/index.md +++ b/docs/src/content/docs/how-to-contribute/index.md @@ -1,10 +1,10 @@ --- -title: Introduction -description: A guide in my new Starlight docs site. +title: How to contribute on this project --- -This codebase was created to demonstrate a fully fledged fullstack application built with Angular, ngrx/platform, nrwl/nx including CRUD operations, authentication, routing, pagination, and more. +There are different ways to contribute on this project. Here are some of them: -We've gone to great lengths to adhere to the Angular community styleguides & best practices. - -For more information on how to this works with other frontends/backends, head over to the [RealWorld](https://github.com/gothinkster/realworld) repo. +1. Open an issue for a bug you found +2. Extend the documentation with more content +3. Add unit tests or e2e tests +4. Open a PR to suggest how the code can be improved diff --git a/docs/src/content/docs/introduction/explanation.md b/docs/src/content/docs/introduction/explanation.md index 7cb0127d..6018a303 100644 --- a/docs/src/content/docs/introduction/explanation.md +++ b/docs/src/content/docs/introduction/explanation.md @@ -1,10 +1,9 @@ --- title: Introduction -description: A guide in my new Starlight docs site. --- -This codebase was created to demonstrate a fully fledged fullstack application built with Angular, ngrx/platform, nrwl/nx including CRUD operations, authentication, routing, pagination, and more. +This codebase was created to demonstrate a fully fledged fullstack application built with [Angular](https://angular.dev/), [ngrx/signals](https://ngrx.io/guide/signals), [nrwl/nx](https://nx.dev/) including CRUD operations, authentication, routing, pagination, and more. It is an implementation of the [RealWorld apps](https://github.com/gothinkster/realworld) project. The purpose of the `RealWorld apps` project is to demonostrate how you can build the same "realworld" app using different technologies in the front-end and on the back-end. -We've gone to great lengths to adhere to the Angular community styleguides & best practices. +This specific implementation was created in 2017 and it is constantly migrated to the latest versions of Angular and it utilizes most of the features of the Modern Angular era. You can help us to maintain this project in various ways. You can find some of them in the [how to contribute]() guide. For more information on how to this works with other frontends/backends, head over to the [RealWorld](https://github.com/gothinkster/realworld) repo. diff --git a/docs/src/content/docs/introduction/index.md b/docs/src/content/docs/introduction/index.md index 7cb0127d..9e2d6378 100644 --- a/docs/src/content/docs/introduction/index.md +++ b/docs/src/content/docs/introduction/index.md @@ -1,10 +1,11 @@ --- title: Introduction -description: A guide in my new Starlight docs site. --- -This codebase was created to demonstrate a fully fledged fullstack application built with Angular, ngrx/platform, nrwl/nx including CRUD operations, authentication, routing, pagination, and more. +This codebase was created to demonstrate a fully-fledged, full-stack application built with [Angular](https://angular.dev/), [ngrx/signals](https://ngrx.io/guide/signals) and [nrwl/nx](https://nx.dev/). It includes CRUD operations, authentication, routing, pagination, and more. It is an implementation of the [RealWorld apps](https://github.com/gothinkster/realworld) project, which aims to show how the same "real-world" app can be built using different technologies on the front-end and back-end. -We've gone to great lengths to adhere to the Angular community styleguides & best practices. +This specific implementation was created in 2017 and is constantly updated to the latest versions of Angular, utilizing most of the features of the modern Angular era. You can help us maintain this project in various ways; find out how in the [How to contribute](../how-to-contribute). -For more information on how to this works with other frontends/backends, head over to the [RealWorld](https://github.com/gothinkster/realworld) repo. +Check the [next](./features) section to see how this app works, which features are included, and how they are connected to the architecture decisions made during development. + +For more information on how this works with other front-ends/back-ends, head over to the [RealWorld apps](https://github.com/gothinkster/realworld) repo. \ No newline at end of file