Skip to content

Commit 68a3c0b

Browse files
committed
docs: reorganize documents
Our non-technical documents are currently floating around loosely in our project's root, making it harden than necessary to discover what one is searching for. We do have a "docs/" directory, though, which serves exactly that purpose of hosting documentation. Move our non-technical documentation into the "docs/" directory. Adjust all links to these documents.
1 parent 8f96cf9 commit 68a3c0b

File tree

9 files changed

+16
-18
lines changed

9 files changed

+16
-18
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@ Quick Start
6969
2. Create the cmake build environment: `cmake ..`
7070
3. Build libgit2: `cmake --build .`
7171

72-
Trouble with these steps? Read `TROUBLESHOOTING.md`. More detailed build
73-
guidance is available below.
72+
Trouble with these steps? Read our (troubleshooting guide)[docs/troubleshooting.md].
73+
More detailed build guidance is available below.
7474

7575
Getting Help
7676
============
@@ -170,12 +170,12 @@ require assistance coordinating this, simply have the worker threads call
170170
Threading
171171
=========
172172

173-
See [THREADING](THREADING.md) for information
173+
See [threading](docs/threading.md) for information
174174

175175
Conventions
176176
===========
177177

178-
See [CONVENTIONS](CONVENTIONS.md) for an overview of the external
178+
See [conventions](docs/conventions.md) for an overview of the external
179179
and internal API/coding conventions we use.
180180

181181
Building libgit2 - Using CMake
@@ -364,10 +364,10 @@ We welcome new contributors! We have a number of issues marked as
364364
and
365365
["easy fix"](https://github.com/libgit2/libgit2/issues?utf8=✓&q=is%3Aissue+is%3Aopen+label%3A%22easy+fix%22)
366366
that are good places to jump in and get started. There's much more detailed
367-
information in our list of [outstanding projects](PROJECTS.md).
367+
information in our list of [outstanding projects](docs/projects.md).
368368

369-
Please be sure to check the [contribution guidelines](CONTRIBUTING.md) to
370-
understand our workflow, and the libgit2 [coding conventions](CONVENTIONS.md).
369+
Please be sure to check the [contribution guidelines](docs/contributing.md) to
370+
understand our workflow, and the libgit2 [coding conventions](docs/conventions.md).
371371

372372
License
373373
==================================
File renamed without changes.
File renamed without changes.

CONTRIBUTING.md renamed to docs/contributing.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Before wrapping up a PR, you should be sure to:
9797

9898
* Write tests to cover any functional changes
9999
* Update documentation for any changed public APIs
100-
* Add to the [`CHANGELOG.md`](CHANGELOG.md) file describing any major changes
100+
* Add to the [`changelog.md`](changelog.md) file describing any major changes
101101

102102
## Unit Tests
103103

@@ -168,10 +168,8 @@ function and type naming, code formatting, and testing.
168168

169169
We like to keep the source code consistent and easy to read. Maintaining
170170
this takes some discipline, but it's been more than worth it. Take a look
171-
at the [conventions
172-
file](https://github.com/libgit2/libgit2/blob/development/CONVENTIONS.md).
171+
at the [conventions file](conventions.md).
173172

174173
## Starter Projects
175174

176-
See our [projects
177-
list](https://github.com/libgit2/libgit2/blob/development/PROJECTS.md).
175+
See our [projects list](projects.md).
File renamed without changes.

PROJECTS.md renamed to docs/projects.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ ideas that no one is actively working on.
1010

1111
## Before You Start
1212

13-
Please start by reading the [README.md](README.md),
14-
[CONTRIBUTING.md](CONTRIBUTING.md), and [CONVENTIONS.md](CONVENTIONS.md)
13+
Please start by reading the [README.md](../README.md),
14+
[contributing.md](contributing.md), and [conventions.md](conventions.md)
1515
files before diving into one of these projects. Those explain our work
1616
flow and coding conventions to help ensure that your work will be easily
1717
integrated into libgit2.

docs/release.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ We aim to release once every six months. We start the process by opening an issu
1414
- [ ] Make a release candidate
1515
- [ ] Plug any final leaks
1616
- [ ] Fix any last-minute issues
17-
- [ ] Make sure CHANGELOG reflects everything worth discussing
18-
- [ ] Update the version in CHANGELOG and the header
17+
- [ ] Make sure changelog.md reflects everything worth discussing
18+
- [ ] Update the version in changelog.md and the header
1919
- [ ] Produce a release candidate
2020
- [ ] Tag
2121
- [ ] Create maint/v0.X
@@ -25,12 +25,12 @@ We tag at least one release candidate. This RC must carry the new version in the
2525

2626
Preparing the first release candidate includes updating the version number of libgit2 to the new version number. To do so, a pull request shall be submitted that adjusts the version number in the following places:
2727

28-
- CHANGELOG.md
28+
- docs/changelog.md
2929
- include/git2/version.h
3030

3131
As soon as the pull request is merged, the merge commit shall be tagged with a lightweight tag.
3232

33-
The tagging happens via GitHub's "releases" tab which lets us attach release notes to a particular tag. In the description we include the changes in `CHANGELOG.md` between the last full release. Use the following as a base for the release notes
33+
The tagging happens via GitHub's "releases" tab which lets us attach release notes to a particular tag. In the description we include the changes in `docs/changelog.md` between the last full release. Use the following as a base for the release notes
3434

3535
This is the first release of the v0.X series, <codename>. The changelog follows.
3636

File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)