Skip to content
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.

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

Add links to documentation #1085

Merged
merged 3 commits into from
Sep 26, 2024
Merged

Add links to documentation #1085

merged 3 commits into from
Sep 26, 2024

Conversation

Hinton
Copy link
Member

@Hinton Hinton commented Sep 26, 2024

📔 Objective

Add links to documentation.

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
    team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed
    issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

Copy link
Contributor

github-actions bot commented Sep 26, 2024

Logo
Checkmarx One – Scan Summary & Detailsf9fd5c6d-5f17-4d83-abe3-0a370e9d29fa

No New Or Fixed Issues Found

Copy link

codecov bot commented Sep 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.27%. Comparing base (4d5b713) to head (84b1022).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1085   +/-   ##
=======================================
  Coverage   58.27%   58.27%           
=======================================
  Files         192      192           
  Lines       13486    13486           
=======================================
  Hits         7859     7859           
  Misses       5627     5627           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

README.md Outdated

You can also browse the latest published documentation:

- [docs.rs](https://docs.rs/bitwarden/0.5.0/bitwarden/) for the public SDK.
Copy link
Member

Choose a reason for hiding this comment

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

We should probably point to https://docs.rs/bitwarden/latest/bitwarden/ or https://docs.rs/bitwarden/, otherwise the link will be outdated once the next release comes out

@Hinton Hinton merged commit 2d1c687 into main Sep 26, 2024
97 checks passed
@Hinton Hinton deleted the ps/link-docs branch September 26, 2024 17:12
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