Skip to content
This repository was archived by the owner on Apr 17, 2020. It is now read-only.

Commit 8867004

Browse files
cdeckerrustyrussell
authored andcommitted
docs: Consolidating header hierarchy slightly
This is a preparatory step for the automatic documentation generation that is going to use `sphinx-doc`. Each document should include a top level header that matches the name and scope of the document and all following headers should be of a lower level than the top-level header. Signed-off-by: Christian Decker <[email protected]>
1 parent ac6d9b3 commit 8867004

File tree

4 files changed

+16
-10
lines changed

4 files changed

+16
-10
lines changed

doc/HACKING.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
Hacking
2+
=======
3+
14
Welcome, fellow coder!
25

36
This repository contains a code to run a lightning protocol daemon.

doc/INSTALL.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Table of Contents
1+
Install
2+
=======
3+
24
1. [Library Requirements](#library-requirements)
35
2. [Ubuntu](#to-build-on-ubuntu)
46
3. [Fedora](#to-build-on-fedora)

doc/MAKING-RELEASES.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1+
## Release checklist
2+
13
Here's a checklist for the release process.
24

3-
## Leading Up To The Release
5+
### Leading Up To The Release
46

57
1. Talk to team about whether there are any changes which MUST go in
68
this release which may cause delay.
@@ -9,22 +11,22 @@ Here's a checklist for the release process.
911
3. Ask the most significant contributor who has not already named a
1012
release to name the release. CC previous namers and team.
1113

12-
## Prepering for -rc1
14+
### Prepering for -rc1
1315

1416
1. Check that CHANGELOG.md covers all signficant changes.
1517
2. Update the CHANGELOG.md with [Unreleased] changed to -rc1, and add a new
1618
footnote.
1719
3. Create a PR with the above.
1820

19-
## Releasing -rc1
21+
### Releasing -rc1
2022

2123
1. Merge the PR above.
2224
2. Tag it `git pull && git tag -s v<VERSION>rc1 && git push --tags`
2325
3. Update the /topic on #c-lightning on Freenode.
2426
4. Prepare draft release notes, and share with team for editing.
2527
5. Upgrade your personal nodes to the rc1, to help testing.
2628

27-
## Tagging the Release
29+
### Tagging the Release
2830

2931
1. Update the CHANGELOG.md; remove -rc1 in both places, and move the
3032
[Unreleased] footnote URL from the previous version to the
@@ -41,15 +43,15 @@ Here's a checklist for the release process.
4143
with `gpg --verify SHA256SUMS.asc` and include the file in the draft
4244
release.
4345

44-
## Performing the Release
46+
### Performing the Release
4547

4648
1. Edit the GitHub draft and include the `SHA256SUMS.asc` file.
4749
2. Publish the release as not a draft.
4850
3. Update the /topic on #c-lightning on Freenode.
4951
4. Send a mail to c-lightning and lightning-dev mailing lists, using the
5052
same wording as the Release Notes in github.
5153

52-
## Post-release
54+
### Post-release
5355

5456
1. Add a new '[Unreleased]' section the CHANGELOG.md with empty headers.
5557
2. Look through PRs which were delayed for release and merge them.

doc/TOR.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
# HOWTO USE TOR WITH C-LIGHTNING
1+
# Setting up TOR with c-lightning
22

33
to use tor you have to have tor installed an running.
44

5-
i.e.
6-
```
5+
```bash
76
sudo apt install tor
87
```
98
then `/etc/init.d/tor start` or `sudo systemctl start tor` Depending

0 commit comments

Comments
 (0)