Skip to content

Commit

Permalink
fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
fedemutt committed Aug 13, 2021
1 parent 99aef3c commit 711ec5f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions documentation/source/developers_starting_point.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ pip install --upgrade git+https://gitlab.com/mutt_data/muttlib#egg=muttlib

# Next Steps
* If you already have the project running the last step before making your first commit is to review the
[development pipeline](https://mutt_data.gitlab.io/soam/development_pipeline.html).
* If you want more information about the main classes or patterns in the project go to [classes document](https://mutt_data.gitlab.io/soam/classes.html).
[development pipeline](./development_pipeline.html).
* If you want more information about the main classes or patterns in the project go to [classes document](./classes.html).
* If you need to understand a library, technology or concept in the project you can check the
[references](https://mutt_data.gitlab.io/soam/references.html).
[references](./references.html).

10 changes: 5 additions & 5 deletions documentation/source/project_structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
### [gitignore](https://gitlab.com/mutt_data/soam/-/blob/master/.gitignore)
This [description file](https://git-scm.com/docs/gitignore) specifies the excluded documents and folders from git.

### [README](https://mutt_data.gitlab.io/soam/README.html)
### [README](./README.html)
This document contains a brief overview of the project working and how to use it, it's oriented to the users of the
package.

Expand All @@ -16,23 +16,23 @@ determines how the SoaM package is going to be installed and what commands it su
This [ini file](https://packaging.python.org/guides/distributing-packages-using-setuptools/#setup-cfg) defines default
options for the setup.py commands.

## [documentation](https://mutt_data.gitlab.io/soam/development_pipeline.html#documentation)
## [documentation](./development_pipeline.html#documentation)
Contains the technical documentation for the project, it's oriented to the development team.

### [images](https://gitlab.com/mutt_data/soam/-/tree/master/documentation/images)
The diagrams and visualizations for the documentation.

### [classes](https://mutt_data.gitlab.io/soam/classes.html)
### [classes](./classes.html)
Explanation and diagrams of the classes and patterns in the project.

### [developers starting point](https://mutt_data.gitlab.io/soam/developers_starting_point.html)
### [developers starting point](./developers_starting_point.html)
Steps description to setup the project for development. If you are new in SoaM this is your next document in your path
to start developing.

### project structure
This document :D

### [references](https://mutt_data.gitlab.io/soam/references.html)
### [references](./references.html)
Papers, articles and videos to understand the theoretical background, libraries and technologies used in the project.

[//comment]: # (TODO: ### architecture)
Expand Down

0 comments on commit 711ec5f

Please sign in to comment.