README.md 8.31 KB
Newer Older
Olivier HEMAR's avatar
Olivier HEMAR committed
1
# Quick Access
Olivier HEMAR's avatar
Olivier HEMAR committed
2 3

[[_TOC_]]
Olivier HEMAR's avatar
Olivier HEMAR committed
4

Olivier HEMAR's avatar
Olivier HEMAR committed
5
# Deep Algo Docs
Olivier HEMAR's avatar
Olivier HEMAR committed
6

Olivier HEMAR's avatar
Olivier HEMAR committed
7 8 9 10
Welcome to [Deep Algo](https://www.deepalgo.com/) Documentation!

We’re glad to have you here!

Olivier HEMAR's avatar
Olivier HEMAR committed
11 12
As a Deep Algo user you’ll have access to all features your subscription includes.
Overview
Olivier HEMAR's avatar
Olivier HEMAR committed
13

Olivier HEMAR's avatar
Olivier HEMAR committed
14 15 16 17 18 19 20
# 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.
Olivier HEMAR's avatar
Olivier HEMAR committed
21 22

## Prerequisites
Olivier HEMAR's avatar
Olivier HEMAR committed
23
- 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.
Olivier HEMAR's avatar
Olivier HEMAR committed
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

- 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.

Olivier HEMAR's avatar
Olivier HEMAR committed
45
- As of today, the managed language is Java.
Olivier HEMAR's avatar
Olivier HEMAR committed
46

Olivier HEMAR's avatar
Olivier HEMAR committed
47 48
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.

Olivier HEMAR's avatar
Olivier HEMAR committed
49 50 51 52 53 54
<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>

Olivier HEMAR's avatar
Olivier HEMAR committed
55
## Use cases
Olivier HEMAR's avatar
Olivier HEMAR committed
56 57
- document as a code (Docs as Code) in english
- get an overview of your application
Olivier HEMAR's avatar
Olivier HEMAR committed
58
- document automatically methods and variables from your Git repository
Olivier HEMAR's avatar
Olivier HEMAR committed
59 60 61 62
- integrate the documentation workflow in your DevOps toolchain
- keep this documentation updated by integrating this workflow in your CI
- 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.
Olivier HEMAR's avatar
Olivier HEMAR committed
63

Olivier HEMAR's avatar
Olivier HEMAR committed
64 65 66 67 68 69
<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>

Olivier HEMAR's avatar
Olivier HEMAR committed
70
## Overview
Olivier HEMAR's avatar
Olivier HEMAR committed
71 72
Following is the overall workflow:
- [Connect](connect/connect.md) the Deep Algo platform (https://app.deepalgo.com)
Olivier HEMAR's avatar
Olivier HEMAR committed
73
- [Create](projects/create.md) a project
Olivier HEMAR's avatar
Olivier HEMAR committed
74
- [Launch](pipelines/pipelines.md) a documentation
Olivier HEMAR's avatar
Olivier HEMAR committed
75
- [Automate your documentation](ci-cd/ci-cd.md)
Olivier HEMAR's avatar
Olivier HEMAR committed
76

Olivier HEMAR's avatar
Olivier HEMAR committed
77 78 79 80 81 82
<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>

Olivier HEMAR's avatar
Olivier HEMAR committed
83
## Quick Start with our Hello World!
Olivier HEMAR's avatar
Olivier HEMAR committed
84

Olivier HEMAR's avatar
Olivier HEMAR committed
85
Let's start the [Hello World](hello/hello-world.md) tutorial!
Olivier HEMAR's avatar
Olivier HEMAR committed
86

Olivier HEMAR's avatar
Olivier HEMAR committed
87 88 89 90
# User Documentation

## Connection to Deep Algo

Olivier HEMAR's avatar
Olivier HEMAR committed
91 92 93 94 95 96 97 98
Here, you can find all the details to [Connect](connect/connect.md) the Deep Algo platform (https://app.deepalgo.com)


<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>
Olivier HEMAR's avatar
Olivier HEMAR committed
99 100 101

## Create a project

Olivier HEMAR's avatar
Olivier HEMAR committed
102
The best way to create your first project is to read this doc: "[Create a project](projects/create.md)".
Olivier HEMAR's avatar
Olivier HEMAR committed
103 104 105 106 107 108 109 110 111

<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>

## List your projects by organizations

Olivier HEMAR's avatar
Olivier HEMAR committed
112
Let's learn how you can easily get a [list of your projects](projects/project-list.md) by organizations.
Olivier HEMAR's avatar
Olivier HEMAR committed
113 114 115 116 117 118 119

<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>

Olivier HEMAR's avatar
Olivier HEMAR committed
120 121
## The project page

Olivier HEMAR's avatar
Olivier HEMAR committed
122 123
![Settings Menu](img/settings-menu.png)

Olivier HEMAR's avatar
Olivier HEMAR committed
124
The project page contains different menu to manage :
Olivier HEMAR's avatar
Olivier HEMAR committed
125 126 127 128
- [Settings](settings/settings.md) Menu
- [Docs](docs/docs.md) Menu ([Docs as Code](docs/docs.md#doc-as-code), [Interactive doc](docs/docs.md#interactive-doc), [Doc on demand](docs/docs.md#doc-on-demand))
- [Pipelines](pipelines/pipelines.md) Menu
- [CI/CD](ci-cd/ci-cd.md) Menu
Olivier HEMAR's avatar
Olivier HEMAR committed
129

Olivier HEMAR's avatar
Olivier HEMAR committed
130 131 132 133 134
<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>
Olivier HEMAR's avatar
Olivier HEMAR committed
135

Olivier HEMAR's avatar
Olivier HEMAR committed
136
## Manage your organizations
Olivier HEMAR's avatar
Olivier HEMAR committed
137

Olivier HEMAR's avatar
Olivier HEMAR committed
138 139
For more information, learn how to [manage your organization](organizations/organizations.md).

Olivier HEMAR's avatar
Olivier HEMAR committed
140 141 142 143 144
<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>
Olivier HEMAR's avatar
Olivier HEMAR committed
145 146 147

## Manage your profile

Olivier HEMAR's avatar
Olivier HEMAR committed
148 149 150
Learn how to [manage your profile](profile/profile.md).


Olivier HEMAR's avatar
Olivier HEMAR committed
151 152 153 154 155
<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>
Olivier HEMAR's avatar
Olivier HEMAR committed
156 157 158 159 160

# Support and Help Center

We use Intercom Chat both to enable real-time communication with our support team and fix your issues as soon as possible.

Olivier HEMAR's avatar
Olivier HEMAR committed
161
![Intercom](img/intercom_chatbot.png)
Olivier HEMAR's avatar
Olivier HEMAR committed
162

Olivier HEMAR's avatar
Olivier HEMAR committed
163
Feel free to contact us by clicking the Chatbot at the right bottom of your browser.
Olivier HEMAR's avatar
Olivier HEMAR committed
164

Olivier HEMAR's avatar
Olivier HEMAR committed
165 166 167 168 169
<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>
Olivier HEMAR's avatar
Olivier HEMAR committed
170

Olivier HEMAR's avatar
Olivier HEMAR committed
171 172 173 174
# Subscription plan

To get all information about our subscription plan, feel free to visit our website (https://www.deepalgo.com).

Olivier HEMAR's avatar
Olivier HEMAR committed
175 176
# What's new?

Olivier HEMAR's avatar
Olivier HEMAR committed
177
#### 20.1.3
Olivier HEMAR's avatar
Olivier HEMAR committed
178
What an easy question! Everything is new!  Enjoy!
Olivier HEMAR's avatar
Olivier HEMAR committed
179

Olivier HEMAR's avatar
Olivier HEMAR committed
180 181
The last version is 20.1.3. You can see the version you use by clicking on the
information icon ![information-icon](img/information-icon.png).
Olivier HEMAR's avatar
Olivier HEMAR committed
182

Olivier HEMAR's avatar
Olivier HEMAR committed
183 184 185 186 187 188
<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>

Olivier HEMAR's avatar
Olivier HEMAR committed
189 190
# What's next?

Olivier HEMAR's avatar
Olivier HEMAR committed
191
What about the next development of Deep Algo?
Olivier HEMAR's avatar
Olivier HEMAR committed
192

Olivier HEMAR's avatar
Olivier HEMAR committed
193
Help us to develop the most valuable features.
Olivier HEMAR's avatar
Olivier HEMAR committed
194

Olivier HEMAR's avatar
Olivier HEMAR committed
195
![Intercom](img/intercom_chatbot.png)
Olivier HEMAR's avatar
Olivier HEMAR committed
196

Olivier HEMAR's avatar
Olivier HEMAR committed
197
Give us some feedbacks using the Chatbot at the bottom right corner.
Olivier HEMAR's avatar
Olivier HEMAR committed
198

Olivier HEMAR's avatar
Olivier HEMAR committed
199 200 201 202
Some ideas:
- C# language
- ….

Olivier HEMAR's avatar
Olivier HEMAR committed
203 204 205 206 207
<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>
Olivier HEMAR's avatar
Olivier HEMAR committed
208

Olivier HEMAR's avatar
Olivier HEMAR committed
209 210 211
# Frequently Asked Questions (FAQ)

## What is out of Deep algo's scope?
Olivier HEMAR's avatar
Olivier HEMAR committed
212

Olivier HEMAR's avatar
Olivier HEMAR committed
213
- All the external components of your code (because we can't analyse a code we don’t have :) )
Olivier HEMAR's avatar
Olivier HEMAR committed
214 215 216 217 218 219 220
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!

- Licenses: There is great to deal with this pain on the market!

- Class Diagrams: we’re sure you can find that in your IDE.

- Your Code of conduct :-)
Olivier HEMAR's avatar
Olivier HEMAR committed
221 222 223 224 225 226

<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>
Olivier HEMAR's avatar
Olivier HEMAR committed
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259

## 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>