Commit bdab93a0 authored by Olivier HEMAR's avatar Olivier HEMAR

README.md

parent fc86fad2
......@@ -11,15 +11,47 @@ We’re glad to have you here!
As a Deep Algo user you’ll have access to all features your subscription includes.
Overview
Deep Algo is a Software As a Service an API that automatically documents your code.
# What is Deep Algo?
As a developer, incomplete or outdated documentation is a pervasive problem.
Deep Algo is SaaS platform which provides an automated and up-to-date documentation of your code base.
You eventually get a living insight of you business algorithms.
## Prerequisites
- Your source code is managed by a Git source control like Gitlab, Github or Bitbucket. We just need the Git URL and the read access credentials.
- Chrome, Chromium or Firefox browser
- Our **supported Web browsers**
Connect to Deep Algo from the web on your desktop anytime at https://app.deepalgo.com
| Browser | Requirements |
|:----------|----------------------|
| Chrome | Version 79 or above |
| Chromium | |
| Firefox | |
- Unsupported browsers
To focus on delivering the best possible experience in Deep Algo, it is necessary
to keep the list of supported browsers short.
When a browser is no longer supported, we stop fixing pesky bugs and issues.
- **Mobile browsers**
We're working hard to have the solution working on mobile and tablets, but as
far as now we do not support the use on mobile because the user experience is
not good. We'll keep you inform as soon as this feature is available.
- As of today, the managed language is Java.
We’re working hard to add new languages. Don’t hesitate to tell us which one would be the most valuable for you ! Use the Chatbot at the bottom right corner.
<div align="right">
<a type="button" class="btn btn-default" href="#quick-access">
Back to Quick Access <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
## Use cases
- document as a code (Docs as Code) in english
- get an overview of your application
......@@ -29,6 +61,12 @@ We’re working hard to add new languages. Don’t hesitate to tell us which one
- get an interactive documentation to simulate outcomes depending on selected conditions
- get warnings when your code needs more tests or documentation directly from the developer.
<div align="right">
<a type="button" class="btn btn-default" href="#quick-access">
Back to Quick Access <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
## Overview
Following is the overall workflow:
- [Connect](connect/connect.md) the Deep Algo platform (https://app.deepalgo.com)
......@@ -36,6 +74,12 @@ Following is the overall workflow:
- [Launch](pipelines/pipelines.md) a documentation
- [Automate your documentation](ci-cd/ci-cd.md)
<div align="right">
<a type="button" class="btn btn-default" href="#quick-access">
Back to Quick Access <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
## Quick Start with our Hello World!
Let's start the [Hello World](hello/hello-world.md) tutorial!
......@@ -162,7 +206,9 @@ Some ideas:
</a>
</div>
# What is out of Deep algo's scope?
# Frequently Asked Questions (FAQ)
## What is out of Deep algo's scope?
- All the external components of your code (because we can't analyse a code we don’t have :) )
It’s eventually great because what you need it’s to document the code implemented by your team. If you need to document an external native API, it’s the purpose of another project, you can document with Deep Algo!
......@@ -178,3 +224,36 @@ It’s eventually great because what you need it’s to document the code implem
Back to Quick Access <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
## Which languages can Deep Algo analyze?
Deep Algo is language agnostic: it's independent of any specific programming
language. We only need to implement the grammar of the language.
Deep Algo can currently manage applications in Java.
We're working hard to add new languages in the coming months.
<div align="right">
<a type="button" class="btn btn-default" href="#quick-access">
Back to Quick Access <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
## How long is an analysis?
Deep Algo is able to analyze 250k lines of a java code in around 3 hours.
<div align="right">
<a type="button" class="btn btn-default" href="#quick-access">
Back to Quick Access <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
## What's your confidence level in an analysis?
For each analysis, we get an understanding indicator with a detailed report of
all the files, lines of code Deep Algo didn't understand.
<div align="right">
<a type="button" class="btn btn-default" href="#quick-access">
Back to Quick Access <i class="fa fa-angle-double-up" aria-hidden="true"></i>
</a>
</div>
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment