Skip to content

Commit 3ce8e17

Browse files
committed
Start the update process #98
Signed-off-by: John M. Horan <johnmhoran@gmail.com>
1 parent 0601cc8 commit 3ce8e17

3 files changed

Lines changed: 22 additions & 27 deletions

File tree

docs/source/aboutcode-data/abcd.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _aboutcode_data:
22

3-
AboutCode Data : ABCD
4-
=====================
3+
AboutCode Data Structure (ABCD)
4+
===============================
55

66
Summary
77
-------

docs/source/contributing.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
############
2-
Contributing
3-
############
1+
#########################
2+
Contributing to AboutCode
3+
#########################
4+
45
The AboutCode organization welcomes you and your interest in contributing to our
56
organization. We are always looking for enthusiatic contributors and we are willing to
67
lend a helping hand if you have any questions or comments. That being said, here a few

docs/source/index.rst

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,38 @@
1-
#######################
2-
AboutCode Documentation
3-
#######################
1+
#########
2+
AboutCode
3+
#########
44

5-
Welcome to the AboutCode documentation.
5+
Welcome to the AboutCode documentation homepage. `AboutCode.org <https://www.aboutcode.org/>`_ is a community of open source developers who are trying to make open source easier to use by providing open source tools to discover, identify and track open source components (aka Software Composition Analysis – SCA). AboutCode is the collective name for these open source tools.
66

7-
This set of documents provides an overview of the AboutCode Projects sponsored by
8-
AboutCode.org (https://www.aboutcode.org), as well as references to the various GitHub project
9-
sites that maintain the actual projects and their documentation.
7+
This home page provides a directory of our major projects and their documentation on ReadTheDocs plus information about how to contribute to AboutCode documentation
108

119
All community contributions are welcome.
1210

11+
1312
----
1413

15-
***************************
16-
AboutCode Organization Docs
17-
***************************
14+
*****************
15+
Table of Contents
16+
*****************
1817

1918
.. toctree::
2019
:maxdepth: 1
2120

22-
contributing
23-
doc_guidelines
2421
aboutcode-project-overview
2522
aboutcode-data/abcd
23+
contributing
24+
doc_guidelines
2625
license
2726

28-
.. aboutcode-docs/home
29-
3027
----
3128

32-
**************
33-
Community Docs
34-
**************
29+
**************************
30+
AboutCode Project Overview
31+
**************************
32+
33+
[to come]
3534

36-
.. toctree::
37-
:maxdepth: 2
3835

39-
gsoc-toc
40-
gsod-toc
41-
contributor_project_ideas
4236

4337

4438
.. Aboutcode Documentation Websites

0 commit comments

Comments
 (0)