Skip to content

Commit 7320764

Browse files
authored
Update index.rst to restructure
Issue #1943
1 parent 4ab8b2f commit 7320764

1 file changed

Lines changed: 62 additions & 42 deletions

File tree

docs/source/index.rst

Lines changed: 62 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,78 @@
1-
Welcome to VulnerableCode!
2-
=============================
1+
VulnerableCode Documentation
2+
============================
33

4-
*VulnerableCode* provides an open database of software packages that are affected
5-
by known security vulnerabilities aka. *"vulnerable packages"*.
4+
*VulnerableCode* provides a Web UI and API to access a database of known software package
5+
vulnerabilities with comprehensive information from upstream and downstream public
6+
sources including packages affected by a vulnerability and packages that fix a
7+
vulnerability.
68

7-
VulnerableCode is also a free and open source software (FOSS) project that
8-
provides the tools to build this open database. The tools handle collecting,
9-
aggregating and correlating these vulnerabilities and relating them to a correct
10-
package version. Our project also supports a public cloud instance of this
11-
database - VulnerableCode.io.
9+
There is a `public VulnerableCode database <https://public.vulnerablecode.io/>`_
10+
and the project also provides the tools to build your own instance of the database.
1211

13-
In this documentation you will find information on:
12+
Documentation overview
13+
~~~~~~~~~~~~~~~~~~~~~~
1414

15-
- An overview of VulnerableCode and what you can do with it
16-
- Installation instructions
17-
- How to make technical contributions to the project and the community
15+
The overview below outlines how the documentation is structured
16+
to help you know where to look for certain things.
1817

19-
.. toctree::
20-
:maxdepth: 2
21-
:caption: Getting Started
18+
.. rst-class:: clearfix row
2219

23-
introduction
24-
user-interface
25-
installation
26-
api
27-
api-admin
28-
contributing
29-
faq
30-
misc
20+
.. rst-class:: column column2 top-left
3121

32-
.. toctree::
33-
:maxdepth: 2
34-
:caption: Tutorial
22+
Getting started
23+
~~~~~~~~~~~~~~~~~~~~~~
3524

36-
tutorial_add_importer_pipeline
37-
tutorial_add_improver_pipeline
25+
Start here if you are new to VulnerableCode.
3826

27+
- :ref:`introduction`
28+
- :ref:`user_interface`
29+
- :ref:`installation`
30+
- :ref:`api`
31+
- :ref:`api-admin`
32+
- :ref:`contributing`
3933

40-
.. toctree::
41-
:maxdepth: 2
42-
:caption: Reference Documentation
34+
.. rst-class:: column column2 top-right
4335

44-
reference_importer_overview
45-
reference_improver_overview
46-
reference_framework_overview
47-
reference_model_overview
48-
command-line-interface
49-
importers_link
36+
Tutorials
37+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5038

51-
.. toctree::
52-
:maxdepth: 1
53-
:caption: Summer of Codes
39+
Learn via practical step-by-step guides.
40+
41+
- :ref:`tutorial_add_importer_pipeline`
42+
- :ref:`tutorial_add_improver_pipeline`
43+
44+
.. rst-class:: column column2 bottom-left
45+
46+
Reference Docs
47+
~~~~~~~~~~~~~~~~~~
48+
49+
Reference documentation for VulnerableCode features and customizations.
50+
51+
- :ref:`reference_importer_overview`
52+
- :ref:`reference_improver_overview`
53+
- :ref:`reference_framework_overview`
54+
- :ref:`reference_model_overview`
55+
- :ref:`command_line_interface`
56+
- :ref:`importers_link`
57+
58+
.. rst-class:: column column2 bottom-right
59+
60+
Explanations
61+
~~~~~~~~~~~~~~~~~~
62+
63+
Consult the reference to understand VulnerableCode concepts.
64+
65+
.. rst-class:: row clearfix
66+
67+
Misc
68+
~~~~~~~~~~~~~~~
69+
70+
- :ref:`faq`
71+
- :ref:`misc`
72+
- :ref:`soc_gsoc21`
73+
74+
.. include:: improve-docs.rst
5475

55-
soc_gsoc21
5676

5777
Indices and tables
5878
==================

0 commit comments

Comments
 (0)