Skip to content

Added links and fixed headings to display table of contents #1278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Y02WK wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added links and fixed headings to display table of contents #1278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions content/en/dev/code.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ menu:
parent: dev
---

### Code structure {#structure}
## Code structure {#structure}

The following overview should not be seen as complete or authoritative, but as a rough guidance to help you find your way in the application.

#### Ruby {#ruby}
### Ruby {#ruby}

`app/controllers`
: Code that binds business logic to templates
Expand Down Expand Up @@ -43,23 +43,23 @@ The following overview should not be seen as complete or authoritative, but as a
`spec`
: Automated test suite

#### JavaScript {#javascript}
### JavaScript {#javascript}

`app/javascript/mastodon`
: Code for the frontend React.js application

`app/javascript/packs`
: Code for non-React.js pages

#### CSS and other assets {#assets}
### CSS and other assets {#assets}

`app/javascript/images`
: Images

`app/javascript/styles`
: Code that turns into CSS via Sass

#### Localizations {#localizations}
### Localizations {#localizations}

`config/locales`
: Server-side localizations in the YML format
Expand Down
4 changes: 2 additions & 2 deletions content/en/dev/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ Mastodon is a Ruby on Rails application with a React.js front-end. It follows s

The best way of working with Mastodon in a development environment is installing all the dependencies on your system, rather than using Docker or Vagrant. You need Ruby, Node.js, PostgreSQL and Redis, which is a pretty standard set of dependencies for Rails applications.

Tutorials for installing these dependencies can be found on the “Installing from source” page in the Running Mastodon section of the documentation. Please keep in mind that root access to a machine running Ubuntu 18.04 is required. After following the installation guide in the Running Mastodon section, see the “Setting up a dev environment” page for further instruction on how to configure your environment for development.
Tutorials for installing these dependencies can be found on the [Installing from source](../../admin/install/) page in the Running Mastodon section of the documentation. Please keep in mind that root access to a machine running Ubuntu 18.04 is required. After following the installation guide in the Running Mastodon section, see the [Setting up a dev environment](../setup/) page for further instruction on how to configure your environment for development.

### Environments {#environments}
## Environments {#environments}

An “environment” is a set of configuration values intended for a specific use case. Some environments could be: development, in which you intend to change the code; test, in which you intend to run the automated test suite; staging, which is meant to preview the code to end-users; and production, which is intended to face end-users. Mastodon comes with configurations for development, test and production.

Expand Down