Update Deltacode documentation as part of Skeleton upgrade #189
Conversation
arnav-mandal1234
changed the title
arnav-mandal1234
changed the title
arnav-mandal1234
force-pushed
the
docs
branch
2 times, most recently
from
522e062
to
7b457b0
Compare
arnav-mandal1234
requested review from
AyanSinhaMahapatra,
JonoYang and
pombredanne
arnav-mandal1234
changed the title
|
|
||
| System Requirements | ||
| ------------------- | ||
|
|
||
| - Hardware : DeltaCode will run best with a modern X86 processor and at least 1GB of RAM and | ||
| 250MB of disk. | ||
| - Hardware : DeltaCode will run best with a modern X86 64 bits processor and at |
There was a problem hiding this comment.
Copied this from scancode-toolkit.
* Modify `docs/source/deltacode/comprehensive_installation.rst`. * Modify `docs/source/deltacode/development.rst`. * Modify `docs/source/index.rst`. * Modify `docs/source/deltacode/GSOC_2021_report.rst`. * Modify `README.rst` * Fixes nexB#188 Signed-off-by: Arnav Mandal <arnav.mandal1234@gmail.com>
| <https://deltacode.readthedocs.io/en/latest/comprehensive_installation.html#docker-install>`_ | ||
|
|
||
|
|
||
| Quick Start |
There was a problem hiding this comment.
I think there should be a sentence mentioning to run ./configure or ./configure --dev prior to running deltacode
There was a problem hiding this comment.
The above section of Quick Start is Installation. It has all the installation guides and I have linked it to the documentation page. See: Development installation from source code using a git clone. Moreover, Quick Start section is to guide everyone on how to use Deltacode.
I have kept the structure same as scancode-toolkit. Let me know what do you think?
There was a problem hiding this comment.
Ah, I see what you mean. That makes sense.
| <https://deltacode.readthedocs.io/en/latest/comprehensive_installation.html#docker-install>`_ | ||
|
|
||
|
|
||
| Quick Start |
There was a problem hiding this comment.
Ah, I see what you mean. That makes sense.
|
LGTM! |
docs/source/deltacode/comprehensive_installation.rst.docs/source/deltacode/development.rst.docs/source/index.rst.docs/source/deltacode/GSOC_2021_report.rst.README.rst