ci: Check-docs for all workspace packages

[shinigami-777]

Description

Issue: #2152

This PR adds a script (ci/check-docs.sh) that checks documentation builds for all workspace packages. The check-docs job is added to the workflow file cont_integration.yml that calls the check-docs.sh script. A justfile recipe just doc added to execute ci/check-docs.sh .

Notes to the reviewers

Currently the bdk_chain and bdk_core checks are failing due to the following errors:

Changelog notice

Checklists

All Submissions:

• I followed the contribution guidelines

New Features:

• I've added tests for the new feature
• I've added docs for the new feature

Bugfixes:

• This pull request breaks the existing API
• I've added tests to reproduce the issue which are now passing
• I'm linking the issue being fixed by this PR

[evanlinjin]

Thanks for this work.

I think it also makes sense to also include the documentation fixes in this PR (as a separate commit).

[ValuedMammal]

@shinigami-777 Can you add a commit addressing the check-docs failures? I recommend removing the redundant explicit link targets in keychain_txout.rs for types that are already in scope (i.e. bitcoin::Script). Then in spk_client.rs update the docs with a valid link to the KeychainTxOutIndex type.

[shinigami-777]

Thanks for this work.

I think it also makes sense to also include the documentation fixes in this PR (as a separate commit).

I have added some doc changes to the CONTRIBUTING.md in this commit.

[shinigami-777]

Updated keychain_txout.rs and spk_client.rs. Now all doc checks are successful.

[oleonardolima]

Thanks for working on this one!

I left some comments as I don't see use for a new check-docs.sh file we should probably just call the cargo commands directly. Let's see what other thinks about it.

Also, you could probably squash it into two commits, something like this:

• ci: add new check-docs job and recipe in justfile
• fix(docs): in keychain_txout.rs and spk_client.rs

[oleonardolima]

nit: it's also a good idea to add the doc to pre-push too.

[shinigami-777]

I added the doc for pre-push in this commit.

[oleonardolima]

I mean, add the doc to the list of commands called (e.g pre-push: fmt check test doc); not a blocker though.

[shinigami-777]

@oleonardolima Thanks for reviewing. I have made the changes and squashed them in 2 commits: c4b8e93 and 1d1e985

[oleonardolima]

utACK 1d1e985