Skip to content

docs: add database backend and runtime feature flags to crate docs#2978

Open
mansiverma897993 wants to merge 1 commit intoSeaQL:masterfrom
mansiverma897993:docs/add-feature-list-to-docs
Open

docs: add database backend and runtime feature flags to crate docs#2978
mansiverma897993 wants to merge 1 commit intoSeaQL:masterfrom
mansiverma897993:docs/add-feature-list-to-docs

Conversation

@mansiverma897993
Copy link

Documentation Improvement

Added a dedicated section in crate-level documentation listing:

  • Supported database backends and their feature flags
  • Supported async runtime feature flags

This improves discoverability of required feature flags
for users enabling specific database connectors.

No runtime behavior changed.
Documentation only.

@Huliiiiii
Copy link
Member

You need to run cargo readme to update README.md.

@mansiverma897993
Copy link
Author

Okk let me do it

@Huliiiiii Huliiiiii requested a review from tyt2y3 March 3, 2026 15:49
@Huliiiiii
Copy link
Member

I just realized we already have a detailed doc here: https://www.sea-ql.org/SeaORM/docs/install-and-config/database-and-async-runtime/.

Not sure if we still need to add this to docs.rs. What do you think, @tyt2y3?

@mansiverma897993
Copy link
Author

Thank you for pointing that out.
Since the documentation already exists on the website, I agree it may not be necessary to duplicate it in docs.rs.

I’m happy to adjust the PR based on your suggestion. @Huliiiiii @tyt2y3

@mansiverma897993
Copy link
Author

@Huliiiiii Any update? How you want to adjust this PR.

@Huliiiiii
Copy link
Member

I'd like to wait for @tyt2y3 to give their feedback before making further changes to this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants