Skip to content

chore(file_store): Document that it's a dev database#1661

Merged
ValuedMammal merged 1 commit intobitcoindevkit:masterfrom
LLFourn:bdk_file_store_is_for_development
Oct 31, 2024
Merged

chore(file_store): Document that it's a dev database#1661
ValuedMammal merged 1 commit intobitcoindevkit:masterfrom
LLFourn:bdk_file_store_is_for_development

Conversation

@LLFourn
Copy link
Copy Markdown
Collaborator

@LLFourn LLFourn commented Oct 27, 2024

Document bdk_file_store is a development/testing database

Copy link
Copy Markdown
Collaborator

@ValuedMammal ValuedMammal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 4b5bd0b

Copy link
Copy Markdown
Collaborator

@oleonardolima oleonardolima left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 4b5bd0b

@@ -1,5 +1,7 @@
# BDK File Store

> ⚠ `bdk_file_store` is a development/testing database. It does not natively support backwards compatible BDK version upgrades so should not be used in production.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd personally make it even clearer by using bold and uppercase.

Suggested change
> `bdk_file_store` is a development/testing database. It does not natively support backwards compatible BDK version upgrades so should not be used in production.
> `bdk_file_store` is a development/testing database. It does not natively support backwards compatible BDK version upgrades so *SHOULD NOT BE USED IN PRODUCTION*.

@LagginTimes
Copy link
Copy Markdown
Contributor

ACK 4b5bd0b

@ValuedMammal ValuedMammal merged commit 493638e into bitcoindevkit:master Oct 31, 2024
@notmandatory notmandatory added this to the 1.0.0-beta milestone Oct 31, 2024
@notmandatory notmandatory added the documentation Improvements or additions to documentation label Oct 31, 2024
@LLFourn LLFourn deleted the bdk_file_store_is_for_development branch November 18, 2024 05:02
@notmandatory notmandatory mentioned this pull request Dec 12, 2024
32 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

5 participants