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.

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

Edit/Create - Documentation refactor #46

Merged
merged 44 commits into from
Jul 28, 2020
Merged

Conversation

riccardozambito
Copy link
Contributor

Library documentation refactor:

  • Updated readme.md
  • Created a folder ./docs where are stored the MD files of each doc section ( a macro topic about the library) .
  • Each section contains links to the Platform docs and specific examples.
  • With this PR the name of the library becomes Mia Node.js service library

Checklist

  • your branch will not cause merge conflict with master
  • run npm test
  • tests are included
  • the documentation is updated or integrated accordingly with your changes
  • the code will follow the lint rules and style of the project
  • you are not committing extraneous files or sensible data

@giulioroggero
Copy link
Member

The supported node.js version is 12 lts

@coveralls
Copy link

coveralls commented Jul 24, 2020

Coverage Status

Coverage remained the same at 97.239% when pulling a06f9ba on BMP-392-tech-doc into a9e1091 on master.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/Logging.md Show resolved Hide resolved
docs/Logging.md Outdated Show resolved Hide resolved
docs/Logging.md Outdated Show resolved Hide resolved
docs/Logging.md Outdated Show resolved Hide resolved
docs/Logging.md Outdated Show resolved Hide resolved
riccardozambito and others added 8 commits July 27, 2020 14:06
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
The useless "else" removed
riccardozambito and others added 17 commits July 27, 2020 14:34
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
Co-authored-by: Federico Maggi <7142570+fredmaggiowski@users.noreply.github.com>
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/Decorators.md Outdated Show resolved Hide resolved
docs/Decorators.md Outdated Show resolved Hide resolved
Copy link
Member

@fredmaggiowski fredmaggiowski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor changes

@fredmaggiowski fredmaggiowski merged commit 7d1f12a into master Jul 28, 2020
@fredmaggiowski fredmaggiowski deleted the BMP-392-tech-doc branch July 28, 2020 08:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants