Skip to content

doc: fix broken internal documentation links #329

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zhanzhao-h wants to merge 3 commits into
base: master
Choose a base branch
from
Open

doc: fix broken internal documentation links #329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f24d448
doc: fix Assumeutxo design link
zhanzhao-h Jun 1, 2026
b385374
doc: fix README example links
zhanzhao-h Jun 1, 2026
ae2a20c
doc: fix CONTRIBUTING secp256k1 links
zhanzhao-h Jun 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ In addition, libsecp256k1 tries to maintain the following coding conventions:
```
* Use `unsigned int` instead of just `unsigned`.
* Use `void *ptr` instead of `void* ptr`.
* Arguments of the publicly-facing API must have a specific order defined in [include/secp256k1.h](include/secp256k1.h).
* Arguments of the publicly-facing API must have a specific order defined in [include/secp256k1.h](src/secp256k1/include/secp256k1.h).
* User-facing comment lines in headers should be limited to 80 chars if possible.
* All identifiers in file scope should start with `secp256k1_`.
* Avoid trailing whitespace.
Expand Down Expand Up @@ -100,7 +100,7 @@ To create a HTML report with coloured and annotated source code:
#### Exhaustive tests

There are tests of several functions in which a small group replaces secp256k1.
These tests are *exhaustive* since they provide all elements and scalars of the small group as input arguments (see [src/tests_exhaustive.c](src/tests_exhaustive.c)).
These tests are *exhaustive* since they provide all elements and scalars of the small group as input arguments (see [src/tests_exhaustive.c](src/secp256k1/src/tests_exhaustive.c)).

### Benchmarks

Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,10 +178,10 @@ In "Developer Command Prompt for VS 2022":

Usage examples
-----------
Usage examples can be found in the [examples](examples) directory. To compile them you need to configure with `--enable-examples`.
* [ECDSA example](examples/ecdsa.c)
* [Schnorr signatures example](examples/schnorr.c)
* [Deriving a shared secret (ECDH) example](examples/ecdh.c)
Usage examples can be found in the [examples](src/secp256k1/examples) directory. To compile them you need to configure with `--enable-examples`.
* [ECDSA example](src/secp256k1/examples/ecdsa.c)
* [Schnorr signatures example](src/secp256k1/examples/schnorr.c)
* [Deriving a shared secret (ECDH) example](src/secp256k1/examples/ecdh.c)

To compile the Schnorr signature and ECDH examples, you also need to configure with `--enable-module-schnorrsig` and `--enable-module-ecdh`.

Expand Down
2 changes: 1 addition & 1 deletion doc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ The BGL repo's [root README](/README.md) contains relevant information on the de

### Miscellaneous
- [Assets Attribution](assets-attribution.md)
- [Assumeutxo design](assumeutxo.md)
- [Assumeutxo design](design/assumeutxo.md)
- [BGL.conf Configuration File](BGL-conf.md)
- [CJDNS Support](cjdns.md)
- [Files](files.md)
Expand Down