A library for ATProtocol identities.
1# Useful Prompts
2
3## Find unecessary project dependencies
4
5Analyze all of the project dependencies and identify any that are not necessary or could be reduced. Think very very hard.
6
7## Review and ensure error correctness
8
9Review all of the errors in the `atproto-jetstream` crate and ensure their names, messages, documentation, and usage are correct. Each error must have a globally unique identifier and error numbers must be ordered consistently. Think very very hard.
10
11Review all of the errors and identify any that are unused. Think very very hard.
12
13## Add missing documentation
14
15Using `cargo check`, add documentation to things that are missing documentation to satisfy compiler warnings.
16
17Document the `crates/atproto-oauth/src/pkce.rs` source file. Think very hard.
18
19## Review and ensure README correctness
20
21In the `atproto-record` crate, update project documentation and README files to ensure they are accurate and reflect current source code. Think very very hard.
22
23## Module documentation
24
25Write high level module documentation in the `path/to/file.rs` source file. Documentation should brief and specific. Think very hard about how to do this.
26
27Write high level crate documentation in the `crates/atproto-oauth-axum/src/lib.rs` source file. Documentation should brief and specific. Think very hard about how to do this.
28
29Update the high level module documentation in each of the source files in the `atproto-xrpcs` crates. Documentation should brief and specific. Think very hard about how to do this.
30
31Update the `README.md` files in the `atproto-identity`, `atproto-record`, `atproto-oauth`, `atproto-oauth-axum`, and `atproto-client` crates. Each `README.md` file should include a high level overview of what the crate provides and include a summary of each binary produced by the crate. Think very hard.
32
33Write a project `README.md` file that describes the project as a library that supports ATProtocol identity record signing and verifying. Note that parts of this was extracted from the open sourced https://tangled.sh/@smokesignal.events/smokesignal project. This project is open source under the MIT license.
34
35The `README.md` file should provide a high level overview of all of the project crates. It should also concisely reference the available binaries and provide a minimal example of how to use them.
36
37Write a `README.md` file for the `atproto-oauth` crate. Use `crates/atproto-identity/README.md` and `crates/atproto-record/README.md` as references. Think really hard.
38
39## Check and clippy
40
41Using `cargo clippy`, satisfy warnings. Think very hard about how to do this.
42
43Using `cargo build`, `cargo fmt`, `cargo check`, `cargo clippy`, and `cargo test` identity and resolve and warnings or errors. Work iteratively and think very hard.
44
45## Cleanup and Check
46
47Cleanup and prepare the project for release.
48
491. Review all of the errors in the project crates and ensure their names, messages, documentation, and usage are correct. Each error must have a globally unique identifier and error numbers must be ordered consistently.
50
512. Using `cargo build`, `cargo fmt`, `cargo check`, `cargo clippy`, and `cargo test` identity and resolve and warnings or errors.
52
533. Update the high level module documentation in each of the source files in the project crates. Documentation should brief and specific.
54
554. Update the `README.md` files in each of the project crates. Each `README.md` file should include a high level overview of what the crate provides and include a summary of each binary produced by the crate.
56
575. Update the `README.md` file in the root of the project that describes the project as collection of components used to create ATProtocol applications. Note that parts of this was extracted from the open sourced https://tangled.sh/@smokesignal.events/smokesignal project. This project is open source under the MIT license.
58
596. Ensure the Dockerfile is accurate and correct.
60
61Avoid introducing new dependencies. Think very very hard.
62
63## Release
64
65Ensure all crates can be packaged and published.