Skip to content
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

Rework documentation to make it more complete #128

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

Rework documentation to make it more complete #128

wants to merge 13 commits into from

Commits on Sep 1, 2020

  1. Improve documentation by creating a dedicated folder and adding Archi… 

    …tecture.md inside
    @aboulay
    aboulay committed Sep 1, 2020
    Configuration menu
    Copy the full SHA
    c4f8b6d View commit details
    Browse the repository at this point in the history

  2. Add a new doc about how to handle new network

    @aboulay
    aboulay committed Sep 1, 2020
    Configuration menu
    Copy the full SHA
    354156d View commit details
    Browse the repository at this point in the history

  3. Move README content inside docs/README.md (technical README) and prep… 

    …are rework on README.md
    @aboulay
    aboulay committed Sep 1, 2020
    Configuration menu
    Copy the full SHA
    50fb597 View commit details
    Browse the repository at this point in the history

  4. Move API content from docs/README.md

    @aboulay
    aboulay committed Sep 1, 2020
    Configuration menu
    Copy the full SHA
    016764f View commit details
    Browse the repository at this point in the history

  5. Move Frontend content from docs/README.md

    @aboulay
    aboulay committed Sep 1, 2020
    Configuration menu
    Copy the full SHA
    76efc7a View commit details
    Browse the repository at this point in the history

Commits on Sep 3, 2020

  1. Update beginning of README.md and add full logo

    @aboulay
    adrien.boulay authored and aboulay committed Sep 3, 2020
    Configuration menu
    Copy the full SHA
    e80cfc3 View commit details
    Browse the repository at this point in the history

  2. Update README.md and try to add dynamic link to the Githu documentation

    @aboulay
    adrien.boulay authored and aboulay committed Sep 3, 2020
    Configuration menu
    Copy the full SHA
    b03d3e8 View commit details
    Browse the repository at this point in the history

  3. Update docs/README.md and add file path

    @aboulay
    adrien.boulay authored and aboulay committed Sep 3, 2020
    Configuration menu
    Copy the full SHA
    b5df64b View commit details
    Browse the repository at this point in the history

  4. Refactor the docs/README Table of Contents and complete Proxy documen… 

    …tation
    @aboulay
    adrien.boulay authored and aboulay committed Sep 3, 2020
    Configuration menu
    Copy the full SHA
    b02e455 View commit details
    Browse the repository at this point in the history

  5. Add Project_organization.md

    @aboulay
    aboulay committed Sep 3, 2020
    Configuration menu
    Copy the full SHA
    d43adb4 View commit details
    Browse the repository at this point in the history

  6. Add How_to_run_locally.md

    @aboulay
    aboulay committed Sep 3, 2020
    Configuration menu
    Copy the full SHA
    b86b776 View commit details
    Browse the repository at this point in the history

  7. Remove duplicated part in README.md

    @aboulay
    aboulay committed Sep 3, 2020
    Configuration menu
    Copy the full SHA
    4165260 View commit details
    Browse the repository at this point in the history

  8. Organize docs/README.md and add <TODO> inside not done part

    @aboulay
    aboulay committed Sep 3, 2020
    Configuration menu
    Copy the full SHA
    e91ed25 View commit details
    Browse the repository at this point in the history