feat: add changelog to marketing #1190
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
|
Warning Review failedThe pull request is closed. WalkthroughThe recent changes include the addition of a new Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
github-actions
bot
added
the
apps: marketing
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- apps/marketing/content/changelog.mdx (1 hunks)
- apps/marketing/src/components/(marketing)/footer.tsx (1 hunks)
Files skipped from review due to trivial changes (1)
- apps/marketing/src/components/(marketing)/footer.tsx
Additional context used
LanguageTool
apps/marketing/content/changelog.mdx
[duplication] ~15-~15: Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Context: ...eases/tag/v1.5.5) ### ✅ Show Completed Fields Fields completed by other recipients are not v...
[uncategorized] ~44-~44: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ... The library will also help us to offer Long Term Validation (LTV) for signatures soon. W...
Additional comments not posted (2)
apps/marketing/content/changelog.mdx (2)
6-7: Ensure that the links provided are accessible and updated.Verification successful
The GitHub links provided in the changelog are accessible and return a status code of 200.
- Lines 6-7 in
apps/marketing/content/changelog.mdxScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify accessibility of GitHub links. # Test: Check if the GitHub URLs are accessible. curl -o /dev/null -s -w "%{http_code}\n" https://github.com/documenso/documenso/releases curl -o /dev/null -s -w "%{http_code}\n" https://github.com/documenso/documenso/tagsLength of output: 185
23-23: Ensure the provided link to the Open API docs is correct and accessible.Verification successful
The provided link to the Open API docs redirects to
https://app.documenso.com/api/v1/openapiand is accessible with an HTTP status code of 200.
- [apps/marketing/content/changelog.mdx, line 23]
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check accessibility of the Open API docs link. # Test: Check if the Open API docs URL is accessible. curl -o /dev/null -s -w "%{http_code}\n" https://documen.so/openapiLength of output: 73
Script:
#!/bin/bash # Description: Follow the redirection of the Open API docs link and check the final URL and its status code. # Test: Follow the redirection and get the final URL and status code. curl -Ls -o /dev/null -w "%{url_effective}\n%{http_code}\n" https://documen.so/openapiLength of output: 133
|
|
||
| #### 🔏🦀 @documenso/pdf-sign | ||
|
|
||
| We are pretty hyped about this one: Since version 0.9, we relied on https://github.com/vbuch/node-signpdf to add the digital signatures to our documents. Since signing is at the heart of Documenso, we created our own rust-based library for signing. As of 1.5.4, Documenso's signing runs on @documenso/pdf-sign. The library offers a better architecture to enable signing with private keys that are not stored locally (e.g. via HSM). We are in the process of cleaning up the library to open source it like the rest of Documenso 🌱 The library will also help us to offer Long Term Validation (LTV) for signatures soon. While we are currently limited to signing with PKCS7-B, eventually, we plan to support all common signing standards like PAdES, CAdES, and XAdES. |
There was a problem hiding this comment.
Consider using a hyphen for "Long Term Validation" to form "Long-Term Validation."
- Long Term Validation
+ Long-Term ValidationCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| We are pretty hyped about this one: Since version 0.9, we relied on https://github.com/vbuch/node-signpdf to add the digital signatures to our documents. Since signing is at the heart of Documenso, we created our own rust-based library for signing. As of 1.5.4, Documenso's signing runs on @documenso/pdf-sign. The library offers a better architecture to enable signing with private keys that are not stored locally (e.g. via HSM). We are in the process of cleaning up the library to open source it like the rest of Documenso 🌱 The library will also help us to offer Long Term Validation (LTV) for signatures soon. While we are currently limited to signing with PKCS7-B, eventually, we plan to support all common signing standards like PAdES, CAdES, and XAdES. | |
| We are pretty hyped about this one: Since version 0.9, we relied on https://github.com/vbuch/node-signpdf to add the digital signatures to our documents. Since signing is at the heart of Documenso, we created our own rust-based library for signing. As of 1.5.4, Documenso's signing runs on @documenso/pdf-sign. The library offers a better architecture to enable signing with private keys that are not stored locally (e.g. via HSM). We are in the process of cleaning up the library to open source it like the rest of Documenso 🌱 The library will also help us to offer Long-Term Validation (LTV) for signatures soon. While we are currently limited to signing with PKCS7-B, eventually, we plan to support all common signing standards like PAdES, CAdES, and XAdES. |
Tools
LanguageTool
[uncategorized] ~44-~44: If this is a compound adjective that modifies the following noun, use a hyphen. (EN_COMPOUND_ADJECTIVE_INTERNAL)
Context: ... The library will also help us to offer Long Term Validation (LTV) for signatures soon. W...
| ### ⬇️ Download Completed Documents via API | ||
| Completed documents can now be downloaded via the API using this new endpoint: | ||
|
|
||
| **GET /API/V1//DOCUMENTS/\{ID\}/DOWNLOAD** |
There was a problem hiding this comment.
Tip
Codebase Verification
The API endpoint syntax in the changelog file contains an extra slash after V1. The correct syntax should be /API/V1/DOCUMENTS/{ID}/DOWNLOAD.
- Current incorrect endpoint:
/API/V1//DOCUMENTS/{ID}/DOWNLOAD - Corrected endpoint:
/API/V1/DOCUMENTS/{ID}/DOWNLOAD
Please update the endpoint accordingly.
Analysis chain
Verify the correctness of the API endpoint syntax.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify syntax correctness of the API endpoint.
# Test: Check if the API endpoint follows the correct syntax conventions.
echo "/API/V1//DOCUMENTS/{ID}/DOWNLOAD" | grep -P "^/API/V\d+/DOCUMENTS/\{ID\}/DOWNLOAD$"
Length of output: 91
Script:
#!/bin/bash
# Description: Verify syntax correctness of the API endpoint after removing the extra slash.
# Test: Check if the corrected API endpoint follows the correct syntax conventions.
echo "/API/V1/DOCUMENTS/{ID}/DOWNLOAD" | grep -P "^/API/V\d+/DOCUMENTS/\{ID\}/DOWNLOAD$"
Length of output: 122
ElTimuro
changed the title
|
|
||
| On the security/ compliance side, we also added Signing Certificates and Audit Logs. Every signed document now has a certificate attached, showing technical details of the signature to improve transparency and security. Further, every action on a document from creation to completion is now logged in the audit log to guarantee the integrity of the process. | ||
|
|
||
| #### 🔏🦀 @documenso/pdf-sign |
There was a problem hiding this comment.
Can we add a GitHub repo link to this? @documenso/pdf-sign
|
Thank you for following the naming conventions for pull request titles! 💚🚀 |
added changelog page to marketing site
Summary by CodeRabbit