Code Monkey home page Code Monkey logo

docs's Introduction

Arianee Docs

This repository holds the editable copy in the master branch that is compiled into the site that runs https://docs.arianee.org/docs/introduction

Arianee Project documentation website


The Arianee project mission is to provide the valuable products’ ecosystem a secure environment to create and manage certificates. This documentation is dedicated to third-party developers who want to focus on the application layer and quickly deliver integrated solutions based on standardized certificates.

See live documentation at: https://docs.arianee.org

Building

  1. Install Docker
  2. `docker-compose up
  3. Point your browser http://localhost:3000

Deploying

The live version of the website is hosted as HTML files in the gh-pages branch. To deploy the master branch to gh-pages the maintainer must run this deployment process.

(Currently undocumented)

docs's People

Contributors

alexishecf avatar arnaudprigent avatar christophebelpaire avatar cmostacchi avatar dependabot[bot] avatar fulldecent avatar gnarco avatar hugoo avatar ineiti avatar lucjodet avatar maxteiger avatar mvaullerin avatar stefdelec avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

docs's Issues

Fix QR code

Currently the QR code in the live demo is showing fuzzy.

This can be fixed with CSS: img{image-rendering: pixelated;}

Separate style tags from content

At current, <style> tags are mixed into markdown file, separate them to CSS files

  • This will improve readability and maintainability

Who is Arianee SAS?

An entity "Arianee SAS" is referenced without introduction at https://docs.arianee.org/docs/howToProceed

What is this entity?


Also, please say the name of the entity which publishes docs.arianee.org and arianee.org here:

Screen Shot 2019-11-03 at 10 29 02

Please use the full, legal name of the entity. Bonus points if you will mention the corporation registration number and jurisdiction.

Also, update the WHOIS registration to match.

Too many blockchain projects register their company in weird ways, or not at all. In contrast, we are a professional organization and we should have a MUCH higher standard than blockchain projects. Our benchmark should be companies that have existed 50 years or more.

Specify the target audience for the document

This will help guide this review. But more importantly it will help attract high-quality contribution to the document.

Recommendation:

This documentation is for contributors to applications released by the Arianee project (published under https://github.com/Arianee/) and third-party applications that work with Arianee.

Explain the risk of not using SRI

OPTION 2
On the page https://docs.arianee.org/docs/ArianeeJS

The line is shown:

<script src="https://unpkg.com/@arianee/arianeejs@latest/browser/bundle.js">

This line of code is an unacceptable risk. On the modern web, best practice is to use sub-resource integrity for all external links.

Potential fixes:

  1. Link to a specific version, include SRI, update documentation with the new URI+SRI each time the library is updated
  2. Add a note in the documentation about the risk of not including SRI

I recommend the latter for now. After the API is very stable then we can switch to the former.

Markdown: always use language specifiers

git grep '' | cat docs/ArianeeAsset-i18n.md:
docs/ArianeeAsset-i18n.md: docs/ArianeeAsset.md:
docs/ArianeeAsset.md: docs/ArianeeBrandIdentity-i18n.md:
docs/ArianeeBrandIdentity-i18n.md: docs/ArianeeEvent-i18n.md:
docs/ArianeeEvent-i18n.md: docs/ArianeeIdentity-i18n.md:
docs/ArianeeIdentity-i18n.md: docs/ArianeeIdentity.md:
docs/ArianeeIdentity.md: docs/ArianeeJS.md:
docs/ArianeeJS.md: docs/ArianeeJS.md:
docs/ArianeeJS.md: docs/ArianeeJS.md:
docs/ArianeeJS.md: docs/ArianeeJS.md:
docs/ArianeeJS.md: docs/ArianeeJS.md:
docs/ArianeeJS.md: docs/ArianeeJS.md:
docs/ArianeeJS.md: docs/ArianeeJSCertificate.md:
docs/ArianeeJSCertificate.md: docs/ArianeeJSCertificate.md:
docs/ArianeeJSCertificate.md: docs/ArianeeJSCertificate.md:
docs/ArianeeJSCertificate.md: docs/ArianeeJSCertificate.md:
docs/ArianeeJSCertificate.md: docs/ArianeeJSCertificate.md:
docs/ArianeeJSCertificate.md: docs/ArianeeJSCertificate.md:
docs/ArianeeJSCertificate.md: docs/ArianeeJSCertificate.md:
docs/ArianeeJSCertificate.md: docs/ArianeeJSCertificate.md:
docs/ArianeeJSCertificate.md: docs/ArianeeJSCertificate.md:
docs/ArianeeJSCertificate.md: docs/ArianeeJSCertificate.md:
docs/ArianeeJSCertificate.md: docs/ArianeeJSCertificate.md:
docs/ArianeeJSCertificate.md: docs/ArianeeJSCertificate.md:
docs/ArianeeJSCertificate.md: docs/ArianeeJSCertificate.md:
docs/ArianeeJSCertificate.md: docs/ArianeeJSCertificate.md:
docs/ArianeeJSCertificate.md: docs/ArianeeJSCertificate.md:
docs/ArianeeJSCertificate.md: docs/ArianeeJSCertificate.md:
docs/ArianeeJSCertificate.md: docs/ArianeeJSEconomy.md:
docs/ArianeeJSEconomy.md: docs/ArianeeJSEconomy.md:
docs/ArianeeJSEconomy.md: docs/ArianeeJSEconomy.md:
docs/ArianeeJSEconomy.md: docs/ArianeeJSEconomy.md:
docs/ArianeeJSEconomy.md: docs/ArianeeJSEconomy.md:
docs/ArianeeJSEconomy.md: docs/ArianeeJSEconomy.md:
docs/ArianeeJSEconomy.md: docs/ArianeeJSEconomy.md:
docs/ArianeeJSEconomy.md: docs/ArianeeJSEconomy.md:
docs/ArianeeJSEconomy.md: docs/ArianeeJSEconomy.md:
docs/ArianeeJSEconomy.md: docs/ArianeeJSEconomy.md:
docs/ArianeeJSEconomy.md: docs/ArianeeJSEconomy.md:
docs/ArianeeJSEconomy.md: docs/ArianeeJSWallet.md:
docs/ArianeeJSWallet.md: docs/ArianeeJSWallet.md:
docs/ArianeeJSWallet.md: docs/ArianeeJSWallet.md:
docs/ArianeeJSWallet.md: docs/ArianeeJSWallet.md:
docs/ArianeeJSWallet.md: docs/ArianeeJSWallet.md:
docs/ArianeeJSWallet.md: docs/ArianeeJSWallet.md:
docs/ArianeeJSWallet.md: docs/ArianeeJSWallet.md:
docs/ArianeeJSWallet.md: docs/ArianeeJSWallet.md:
docs/ArianeeJSWallet.md: docs/ArianeeJSWallet.md:
docs/ArianeeJSWallet.md: docs/ArianeeJSWallet.md:
docs/ArianeeJSWallet.md: docs/ArianeeProductCertificate-i18n.md:
docs/ArianeeProductCertificate-i18n.md: docs/arianeeJS-SDK/README.md:
docs/arianeeJS-SDK/README.md: docs/arianeeJS-SDK/README.md:
docs/arianeeJS-SDK/README.md: docs/arianeeJS-SDK/README.md:
docs/arianeeJS-SDK/README.md: docs/arianeeJS-SDK/README.md:
docs/arianeeJS-SDK/README.md: docs/arianeeJS-SDK/README.md:
docs/arianeeJS-SDK/README.md: docs/arianeeJS-SDK/README.md:
docs/arianeeJS-SDK/README.md: website/README.md:
website/README.md: website/README.md:
website/README.md: website/README.md:
website/README.md: website/README.md:
website/README.md: website/README.md:
website/README.md: website/README.md:
website/README.md:```

These should all have a language specified.

Establish and follow style guide, post at https://github.com/Arianee/docs/wiki

  • Establish when words should be in title case or sentence case.
    • Currently there are inconsistencies for example on the left of each page, "KYB Process" is title case but "Staking policy" is sentence case.
  • Choose between ARIA and Aria, both are currently used.
  • Choose between Arianee .Wallet, Arianee Wallet, arianee wallet and Wallet, each is currently used.
  • Choose between arianeeJS and ArianeeJS, both are currently used.

Rename pages

  • docs/intro.md => docs/introduction.md
  • docs/arianeeproject.md => docs/arianee-project.md
  • docs/AriaEconomy => docs/arianee-enocomy.md
  • In general lowercase, hyphenated words

Also, this should be part of the style guide.

CI deploy after PR

After a PR on Docs, it should deploy docs to productions.

Command line that I currently use :
GIT_USER=gnarco CURRENT_BRANCH=master USE_SSH=true npm run publish-gh-pages

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.