Merge pull request #1 from SpaceUY/feat/navigation_section

[FEAT] - added navigation content and fix readme

.gitignore

@@ -13,3 +13,4 @@ _site/
 # Ignore folders generated by Bundler
 .bundle/
 vendor/
+.DS_Store

README.md

@@ -1,174 +1,20 @@
-# just-the-docs-template
+[![SpaceDev](./assets/img/spacedev.svg)](https://www.spacedev.io/)
 
-This is a *bare-minimum* template to create a [Jekyll] site that:
+## React Native Guidelines
 
-- uses the [Just the Docs] theme;
-- can be built and published on [GitHub Pages];
-- can be built and previewed locally, and published on other platforms.
+### Website **[here](https://spaceuy.github.io/react-native-guidelines/)**
 
-More specifically, the created site:
+### Glossary
 
-- uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem;
-- uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages.
+1. **[Home](./index.md)**
+2. **[Environment Setup](docs/network.md)**
+3. **[Navigation](docs/navigation.md.md)**
+4. **[State Management](docs/state.md.md)**
+5. **[Network Management](docs/network.md)**
 
-To get started with creating a site, simply:
+<br />
+<br />
 
-1. click "[use this template]" to create a GitHub repository
-2. go to Settings > Pages > Build and deployment > Source, and select GitHub Actions
+##### Disclaimer
 
-If you want to maintain your docs in the `docs` directory of an existing project repo, see [Hosting your docs from an existing project repo](#hosting-your-docs-from-an-existing-project-repo).
-
-After completing the creation of your new site on GitHub, update it as needed:
-
-## Replace the content of the template pages
-
-Update the following files to your own content:
-
-- `index.md` (your new home page)
-- `README.md` (information for those who access your site repo on GitHub)
-
-## Changing the version of the theme and/or Jekyll
-
-Simply edit the relevant line(s) in the `Gemfile`.
-
-## Adding a plugin
-
-The Just the Docs theme automatically includes the [`jekyll-seo-tag`] plugin.
-
-To add an extra plugin, you need to add it in the `Gemfile` *and* in `_config.yml`. For example, to add [`jekyll-default-layout`]:
-
-- Add the following to your site's `Gemfile`:
-
-  ```ruby
-  gem "jekyll-default-layout"
-  ```
-
-- And add the following to your site's `_config.yml`:
-
-  ```yaml
-  plugins:
-    - jekyll-default-layout
-  ```
-
-Note: If you are using a Jekyll version less than 3.5.0, use the `gems` key instead of `plugins`.
-
-## Publishing your site on GitHub Pages
-
-1.  If your created site is `YOUR-USERNAME/YOUR-SITE-NAME`, update `_config.yml` to:
-
-    ```yaml
-    title: YOUR TITLE
-    description: YOUR DESCRIPTION
-    theme: just-the-docs
-
-    url: https://YOUR-USERNAME.github.io/YOUR-SITE-NAME
-
-    aux_links: # remove if you don't want this link to appear on your pages
-      Template Repository: https://github.com/YOUR-USERNAME/YOUR-SITE-NAME
-    ```
-
-2.  Push your updated `_config.yml` to your site on GitHub.
-
-3.  In your newly created repo on GitHub:
-    - go to the `Settings` tab -> `Pages` -> `Build and deployment`, then select `Source`: `GitHub Actions`.
-    - if there were any failed Actions, go to the `Actions` tab and click on `Re-run jobs`.
-
-## Building and previewing your site locally
-
-Assuming [Jekyll] and [Bundler] are installed on your computer:
-
-1.  Change your working directory to the root directory of your site.
-
-2.  Run `bundle install`.
-
-3.  Run `bundle exec jekyll serve` to build your site and preview it at `localhost:4000`.
-
-    The built site is stored in the directory `_site`.
-
-## Publishing your built site on a different platform
-
-Just upload all the files in the directory `_site`.
-
-## Customization
-
-You're free to customize sites that you create with this template, however you like!
-
-[Browse our documentation][Just the Docs] to learn more about how to use this theme.
-
-## Hosting your docs from an existing project repo
-
-You might want to maintain your docs in an existing project repo. Instead of creating a new repo using the [just-the-docs template](https://github.com/just-the-docs/just-the-docs-template), you can copy the template files into your existing repo and configure the template's Github Actions workflow to build from a `docs` directory. You can clone the template to your local machine or download the `.zip` file to access the files.
-
-### Copy the template files
-
-1.  Create a `.github/workflows` directory at your project root if your repo doesn't already have one. Copy the `pages.yml` file into this directory. GitHub Actions searches this directory for workflow files.
-
-2.  Create a `docs` directory at your project root and copy all remaining template files into this directory.
-
-### Modify the GitHub Actions workflow
-
-The GitHub Actions workflow that builds and deploys your site to Github Pages is defined by the `pages.yml` file. You'll need to edit this file to that so that your build and deploy steps look to your `docs` directory, rather than the project root.
-
-1.  Set the default `working-directory` param for the build job.
-
-    ```yaml
-    build:
-      runs-on: ubuntu-latest
-      defaults:
-        run:
-          working-directory: docs
-    ```
-
-2.  Set the `working-directory` param for the Setup Ruby step.
-
-    ```yaml
-    - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: '3.1'
-          bundler-cache: true
-          cache-version: 0
-          working-directory: '${{ github.workspace }}/docs'
-    ```
-
-3.  Set the path param for the Upload artifact step:
-
-    ```yaml
-    - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
-        with:
-          path: "docs/_site/"
-    ```
-
-4.  Modify the trigger so that only changes within the `docs` directory start the workflow. Otherwise, every change to your project (even those that don't affect the docs) would trigger a new site build and deploy.
-
-    ```yaml
-    on:
-      push:
-        branches:
-          - "main"
-        paths:
-          - "docs/**"
-    ```
-
-## Licensing and Attribution
-
-This repository is licensed under the [MIT License]. You are generally free to reuse or extend upon this code as you see fit; just include the original copy of the license (which is preserved when you "make a template"). While it's not necessary, we'd love to hear from you if you do use this template, and how we can improve it for future use!
-
-The deployment GitHub Actions workflow is heavily based on GitHub's mixed-party [starter workflows]. A copy of their MIT License is available in [actions/starter-workflows].
-
-----
-
-[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).
-
-[Jekyll]: https://jekyllrb.com
-[Just the Docs]: https://just-the-docs.github.io/just-the-docs/
-[GitHub Pages]: https://docs.github.com/en/pages
-[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
-[Bundler]: https://bundler.io
-[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate
-[`jekyll-default-layout`]: https://github.com/benbalter/jekyll-default-layout
-[`jekyll-seo-tag`]: https://jekyll.github.io/jekyll-seo-tag
-[MIT License]: https://en.wikipedia.org/wiki/MIT_License
-[starter workflows]: https://github.com/actions/starter-workflows/blob/main/pages/jekyll.yml
-[actions/starter-workflows]: https://github.com/actions/starter-workflows/blob/main/LICENSE
+<small>Keep in mind that this guideline will keep getting updated with new information and is not a full detailed manual of all Expo functionalities. Instead, it is a guide to understanding the basic operation and structure of both the automatic part and what matters when using the Expo. For more precise details about a specific functionality, please refer to the documentation. If you find any incorrect information, please contact the development team.</small>

docs/navigation.md

@@ -4,4 +4,68 @@ layout: default
 nav_order: 3
 ---
 
-# Navigation
+# Expo Router
+
+Expo router is a multi-platform routing framework for react native and web applications. Is important to mention that It uses a **FILE-BASED** method to determine routes inside your app.
+
+The basic structure would be as follows:
+
+<img src="../assets/img/structure.png" alt="Mobile Development" width="300">
+<br>
+
+### Installation
+
+Expo router is included when creating a default expo project using the following command:
+
+`npx create-expo-app AppName`
+
+### How do \_layout files work?
+
+In the root `_layout`, it is recommended to insert the necessary providers, such as authentication, state management tools, context, themes, etc. In Expo Router, each subfolder created generates what are called 'Route Groups', which can contain their own layout. The layout acts as a sort of middleware for the routes (files) within that folder, allowing us to configure the stacks, tabs, and routes we want to have within each layout. Additionally, any extra logic needed for that subgroup of routes can be added.
+
+It is important to remember that routes must have a unique name globally. Their names must match the existing file for that route, and stack options can be customized by declaring the stack in the respective layout file. It is also important to note that if a folder does not contain a layout, Expo Router automatically generates the stack based on the existing files and their names.
+As a reminder, you can use `useRootNavigationState` from expo-router to debug the navigation state.
+
+### Authentication
+
+For authentication, remember that with Expo Router, all routes are always defined and accessible. You should use runtime logic to redirect users away from specific screens depending on whether they are authenticated.
+
+For example, a basic authentication setup within the app folder:
+
+Create a folder (app) inside the app folder, which will contain a layout file with the stack for authenticated routes and the logic to detect authentication, generally coming from the state declared in the root layout. It can also contain its own bottom tab, which should be created in an internal folder following the same pattern.
+
+In this way, you could create an app that has, for example, a public bottom tab and an authenticated bottom tab.
+
+It would look something like this:
+
+<img src="../assets/img/structure_auth.png" alt="Mobile Development" width="300">
+<br />
+<br />
+
+**./(app)/\_layout** - stack of authenticated routes (includes validation logic and allows for declaring additional routes)
+**./(app)/(nav)** - authenticated bottom tab (following the same tab pattern)
+**./(tabs)** - public bottom tab
+**./\_layout.tsx** - root layout
+
+<br />
+
+Expo Router redirects to the index file of the folder or subfolder it finds. If an index file is not found, it generally may not locate a valid initial route. If there are multiple folders containing an index file, Expo Router will follow the alphabetical order of these folders rather than the order in which routes are defined in the stack.
+
+### Tips
+
+Screen con bottom tab sin tab button:
+To have a route available within a tab stack without displaying the tab button, you can create the file for that route, then define the tab screen in the layout, and in the options for that tab screen, set href:null. The route will exist in the tab stack and will continue to display the bottom tab bar when represented, but without having its own button.
+
+### Sources
+
+https://docs.expo.dev/router/
+https://docs.expo.dev/router/advanced/root-layout/
+https://docs.expo.dev/router/advanced/tabs/
+https://docs.expo.dev/router/advanced/stack/
+
+<br />
+<br />
+
+##### Disclaimer
+
+<small>Keep in mind that this guideline will keep getting updated with new information and is not a full detailed manual of all Expo Router functionalities. Instead, it is a guide to understanding the basic operation and structure of both the automatic part and what matters when using the Expo Router. For more precise details about a specific functionality, please refer to the documentation. If you find any incorrect information, please contact the development team.</small>