GitBook: [docs-linking] 63 pages and 3 assets modified

Author: vfonic

.gitbook/assets/admin_panel_978-2x (2).jpg

@@ -71,7 +71,7 @@ module Spree
 end
 ```
 
-Now, when we head to `http://localhost:3000/admin/products` and edit a product, we should be able to set a sale price for the product and be able to view it on our sale page, `http://localhost:3000/sale`. Note that you will likely need to restart our example Spree application \(created in the [Getting Started tutorial](/developer/getting_started/installation.html)\).
+Now, when we head to `http://localhost:3000/admin/products` and edit a product, we should be able to set a sale price for the product and be able to view it on our sale page, `http://localhost:3000/sale`. Note that you will likely need to restart our example Spree application \(created in the [Getting Started tutorial](https://github.com/vfonic/spree-dev-docs/tree/bfffab2458d4c7cf8b89a67d42adfad0a96424b7/developer/getting_started/installation.html)\).
 
 ### Available actions
 
@@ -100,7 +100,7 @@ Deface currently supports the following actions:
 * :add\_to\_attributes - Appends value to attributes on all elements that match the supplied selector, adds attribute if not present. Expects :attributes option to be passed.
 * :remove\_from\_attributes - Removes value from attributes on all elements that match the supplied selector. Expects :attributes option to be passed.
 
- Not all actions are applicable to all elements. For example, \`:insert\_top\` and \`:insert\_bottom\` expects a parent element with children.
+  Not all actions are applicable to all elements. For example, \`:insert\_top\` and \`:insert\_bottom\` expects a parent element with children.
 
 ### Supplying content
 
@@ -110,7 +110,7 @@ Deface supports three options for supplying content to be used by an override:
 * :partial - Relative path to a partial
 * :template - Relative path to a template
 
- As Deface operates on the Erb source the content supplied to an override can include Erb, it is not limited to just HTML. You also have access to all variables accessible in the original Erb context.
+  As Deface operates on the Erb source the content supplied to an override can include Erb, it is not limited to just HTML. You also have access to all variables accessible in the original Erb context.
 
 ### Targeting elements
 
@@ -244,7 +244,7 @@ These warnings are a good indicator that you need to review the source and ensur
 
 Once you've reviewed the new source you can update the `:original` value to new source to clear the warning.
 
- Deface removes all whitespace from both the actual and \`:original\` source values before comparing, to reduce false warnings caused by basic whitespace differences.
+Deface removes all whitespace from both the actual and \`:original\` source values before comparing, to reduce false warnings caused by basic whitespace differences.
 
 ### Organizing Overrides
 

.gitbook/assets/admin_panel_978-2x (3).jpg

@@ -6,7 +6,7 @@ order: 1
 
 # Adding Spree to an existing Rails application
 
-### Add Spree gems to your `Gemfile`
+## Add Spree gems to your `Gemfile`
 
 ```ruby
 gem 'spree' # core and API
@@ -17,18 +17,18 @@ gem 'spree_sample' # dummy data like products, taxons, etc
 gem 'spree_auth_devise', '~> 4.3' # Devise integration (optional)
 gem 'spree_gateway', '~> 3.9' # payment gateways eg. Stripe, Braintree (optional)
 gem 'spree_i18n', '~> 5.0' # translation files (optional) 
- 
+
 # only needed for MacOS and Ruby 3.0
 gem 'sassc', github: 'sass/sassc-ruby', branch: 'master'
 ```
 
-### Install gems
+## Install gems
 
 ```bash
  bundle install
 ```
 
-### Use the install generators to set up Spree
+## Use the install generators to set up Spree
 
 ```text
 bin/rails g spree:install --user_class=Spree::User
@@ -38,7 +38,7 @@ bin/rails g spree:frontend:install
 bin/rails g spree:backend:install
 ```
 
-### Installation options
+## Installation options
 
 By default, the installation generator \(`rails g spree:install`\) will run migrations as well as adding seed. This can be disabled using
 
@@ -55,7 +55,7 @@ bin/rails db:seed
 bin/rake spree_sampe:load
 ```
 
-### Mounting the Spree engine
+## Mounting the Spree engine
 
 When `rails g spree:install` is run inside an application, it will install Spree, mounting the `Spree::Core::Engine` component by inserting this line automatically into `config/routes.rb`:
 
@@ -73,19 +73,19 @@ mount Spree::Core::Engine, at: `/shop`
 
 The different parts of Spree \(API, Admin\) will be mounted there as well, eg. `http://localhost:3000/shop/admin`.
 
-### Use your existing authentication
+## Use your existing authentication
 
 [Spree Auth Devise](https://github.com/spree/spree_auth_devise) is the default authentication that comes with Spree but you can swap it for your own, please [follow this guide](../customization/authentication.md)
 
-### Hello, Spree Commerce
+## Hello, Spree Commerce
 
 You now have a functional Spree application after running only a few commands!
 
 To see your application in action, open a browser window and navigate to [http://localhost:3000](http://localhost:3000). You should see the Spree default home page:
 
 To stop the webserver, hit Ctrl-C in the terminal window where it's running. In development mode, Spree does not generally require you to stop the server; changes you make in files will be automatically picked up by the server.
 
-#### Logging Into the Admin Panel
+### Logging Into the Admin Panel
 
 The next thing you'll probably want to do is to log into the admin interface. Use your browser window to navigate to [http://localhost:3000/admin](http://localhost:3000/admin). You can log in with the username `[email protected]` and password `spree123`.
 

.gitbook/assets/erd.jpg

@@ -17,7 +17,7 @@ The Spree test code is an evolving story. We started out with RSpec, then switch
 
 ## Testing Spree Components
 
-Spree consists of several different gems \(see the [Understanding Spree](/developer/getting_started/understanding_spree.html#spree-modules) for more details.\) Each of these gems has its own test suite which can be found in the `spec` directory. Since these gems are also Rails engines, they can't really be tested in complete isolation - they need to be tested within the context of a Rails application.
+Spree consists of several different gems \(see the [Understanding Spree](https://github.com/vfonic/spree-dev-docs/tree/bfffab2458d4c7cf8b89a67d42adfad0a96424b7/developer/getting_started/understanding_spree.html#spree-modules) for more details.\) Each of these gems has its own test suite which can be found in the `spec` directory. Since these gems are also Rails engines, they can't really be tested in complete isolation - they need to be tested within the context of a Rails application.
 
 You can easily build such an application by using the Rake task designed for this purpose, running it inside the component you want to test:
 

advanced/deface_overrides_tutorial.md

@@ -12,7 +12,7 @@ API v1 usage is not recommended anymore and will be extracted from Spree in the
 
 ## Introduction
 
-In this tutorial we are going to learn how we can customize the [**REST API**](api) provided by Spree, adding a new endpoint \(or you can override an existing in core\). We will use `spree_simple_sales` extension created in [Extensions tutorial](../extensions/extensions_tutorial.md). If you haven't seen before, please check them!
+In this tutorial we are going to learn how we can customize the [**REST API**](https://github.com/vfonic/spree-dev-docs/tree/bfffab2458d4c7cf8b89a67d42adfad0a96424b7/customization/api/README.md) provided by Spree, adding a new endpoint \(or you can override an existing in core\). We will use `spree_simple_sales` extension created in [Extensions tutorial](../extensions/extensions_tutorial.md). If you haven't seen before, please check them!
 
 ## Adding Custom Endpoints
 
@@ -49,7 +49,7 @@ module Spree
 end
 ```
 
- Note that distinct of \`Spree::HomeController\` from the previous tutorial, we are extending from \`Spree::Api\` module now
+Note that distinct of \`Spree::HomeController\` from the previous tutorial, we are extending from \`Spree::Api\` module now
 
 The difference from `Spree::HomeController.home` action is the 3 last extra lines, that perform:
 
@@ -73,7 +73,7 @@ Spree::Core::Engine.add_routes do
 end
 ```
 
- The \`only:\` symbol defines which actions of the controller are allowed to be endpoints. Whether you don't define this, Spree will try execute a \`SalesController.show\(\)\` action method, that in this case, not exists!
+The \`only:\` symbol defines which actions of the controller are allowed to be endpoints. Whether you don't define this, Spree will try execute a \`SalesController.show\(\)\` action method, that in this case, not exists!
 
 ### Creating a View
 
@@ -95,7 +95,7 @@ attributes *product_attributes << :sale_price
 
 ### Testing Our endpoint
 
-Like described in [Testing Our Decorator](/developer/advanced/extensions_tutorial.html#testing-our-decorator) it's always a good idea to test your code, including your api new/changed endpoints. Let's write a integration test that simulate your api of simple unit tests for `sales_controller.rb`
+Like described in [Testing Our Decorator](https://github.com/vfonic/spree-dev-docs/tree/bfffab2458d4c7cf8b89a67d42adfad0a96424b7/developer/advanced/extensions_tutorial.html#testing-our-decorator) it's always a good idea to test your code, including your api new/changed endpoints. Let's write a integration test that simulate your api of simple unit tests for `sales_controller.rb`
 
 #### Creating and running the test
 
@@ -179,5 +179,5 @@ api_key = user.spree_api_key # Copy the api_key value
 
 Now, when we head to `http://localhost:3000/api/v1/sales`, passing the header `X-Spree-Token: [YOUR_COPIED_API_KEY]`, \(or add a `?token=[YOUR_COPIED_API_KEY]` to the url\) into your browser or any REST client, we should see the json result with all products with a sale price.
 
- Note that you will likely need to restart our example Spree application \(created in the \[Getting Started\]\(/developer/getting\_started/installation.html\) tutorial\).
+Note that you will likely need to restart our example Spree application \(created in the \[Getting Started\]\(/developer/getting\_started/installation.html\) tutorial\).
 

advanced/existing_app_tutorial.md

@@ -11,9 +11,9 @@ description: This page covers customization of both Storefront API and Platform
 
 ### Customizing JSON response
 
-Spree uses J[SON API serializers](https://github.com/jsonapi-serializer/jsonapi-serializer) to represent data returned by API endpoints. 
+Spree uses J[SON API serializers](https://github.com/jsonapi-serializer/jsonapi-serializer) to represent data returned by API endpoints.
 
-You can easily swap OOTB Spree serializers with your own thanks to [Spree Dependencies](dependencies.md). 
+You can easily swap OOTB Spree serializers with your own thanks to [Spree Dependencies](dependencies.md).
 
 #### Adding custom attributes
 
@@ -48,7 +48,7 @@ Let's create a new serializer `app/serializers/video_serializer.rb`:
 ```ruby
 class VideoSerializer < Spree::Api::V2::BaseSerializer
   set_type: :video
-  
+
   attributes :url
 end
 ```
@@ -58,7 +58,7 @@ Now in your `app/serializers/my_product_serializer.rb`
 ```ruby
 class MyProductSerializer < Spree::V2::Storefront::ProductSerializer
   attribute :my_new_custom_attribute
-  
+
   has_many :videos, serializer: :video
 end
 ```

advanced/testing.md

@@ -116,7 +116,7 @@ Each of the methods defined in this module return values that are the most commo
 
   application.
 
- URLs inside the \`spree\_login\_path\`, \`spree\_signup\_path\` and \`spree\_logout\_path\` methods \*\*must\*\* have \`main\_app\` prefixed if they are inside your application. This is because Spree will otherwise attempt to route to a \`login\_path\`, \`signup\_path\` or \`logout\_path\` inside of itself, which does not exist. By prefixing with \`main\_app\`, you tell it to look at the application's routes.
+  URLs inside the \`spree\_login\_path\`, \`spree\_signup\_path\` and \`spree\_logout\_path\` methods \*\*must\*\* have \`main\_app\` prefixed if they are inside your application. This is because Spree will otherwise attempt to route to a \`login\_path\`, \`signup\_path\` or \`logout\_path\` inside of itself, which does not exist. By prefixing with \`main\_app\`, you tell it to look at the application's routes.
 
 You will need to define the `login_path`, `signup_path` and `logout_path` routes yourself, by using code like this inside your application's `config/routes.rb` if you're using Devise:
 
@@ -133,7 +133,7 @@ Of course, this code will be different if you're not using Devise. Simply **do n
 
 You can also customize the `spree_login_path`, `spree_signup_path` and `spree_logout_path` methods inside `lib/spree/authentication_helpers.rb` to use the routing helper methods already provided by the authentication setup you have, if you wish.
 
- Any modifications made to \`lib/spree/authentication\_helpers.rb\` while the server is running will require a restart, as with any other modification to other files in \`lib\`.
+Any modifications made to \`lib/spree/authentication\_helpers.rb\` while the server is running will require a restart, as with any other modification to other files in \`lib\`.
 
 ## The User Model
 
@@ -170,9 +170,9 @@ Finally, if you are using the API component of Spree, there are more methods add
 
 ## Login link
 
- This is only applicable for Spree 4.0 and older. Spree 4.1 and newer releases handle this out of the box.
+This is only applicable for Spree 4.0 and older. Spree 4.1 and newer releases handle this out of the box.
 
-To make the login link appear on Spree pages, you will need to modify `spree/shared/_nav_bar.html.erb` file which you can copy over from Spree codebase to your project \(detailed in [View Customization section](/developer/customization/view.html)\).
+To make the login link appear on Spree pages, you will need to modify `spree/shared/_nav_bar.html.erb` file which you can copy over from Spree codebase to your project \(detailed in [View Customization section](https://github.com/vfonic/spree-dev-docs/tree/bfffab2458d4c7cf8b89a67d42adfad0a96424b7/developer/customization/view.html)\).
 
 You will need to add this code: