[PR #1101] [MERGED] feat: documentation site #1387

Closed
opened 2026-02-26 19:33:02 +03:00 by kerem · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/documenso/documenso/pull/1101
Author: @catalinpit
Created: 4/11/2024
Status: Merged
Merged: 7/22/2024
Merged by: @ElTimuro

Base: mainHead: feat/create-documentation-site


📝 Commits (10+)

  • 5799e36 feat: documentation site
  • b105be2 fix: invalid key
  • 23c4054 fix: app name
  • 24ed73e chore: add package.json commands
  • df699e8 chore: added content and updated settings
  • 1f71baa chore: some changes
  • c29e6ea chore: added frontmatter plus some changes
  • 86df82d chore: hide home from nav
  • bd82d46 chore: add contributing guide
  • 2ed4cb6 chore: improved contributing copy

📊 Changes

143 files changed (+6244 additions, -68 deletions)

View changed files

📝 README.md (+11 -15)
apps/documentation/.gitignore (+36 -0)
apps/documentation/README.md (+36 -0)
apps/documentation/next.config.js (+17 -0)
apps/documentation/package.json (+35 -0)
apps/documentation/pages/_app.mdx (+10 -0)
apps/documentation/pages/_meta.json (+34 -0)
apps/documentation/pages/developers/_meta.json (+16 -0)
apps/documentation/pages/developers/contributing.mdx (+117 -0)
apps/documentation/pages/developers/index.mdx (+18 -0)
apps/documentation/pages/developers/local-development/_meta.json (+7 -0)
apps/documentation/pages/developers/local-development/gitpod.mdx (+10 -0)
apps/documentation/pages/developers/local-development/index.mdx (+63 -0)
apps/documentation/pages/developers/local-development/manual.mdx (+77 -0)
apps/documentation/pages/developers/local-development/quickstart.mdx (+66 -0)
apps/documentation/pages/developers/local-development/signing-certificate.mdx (+61 -0)
apps/documentation/pages/developers/public-api/_meta.json (+5 -0)
apps/documentation/pages/developers/public-api/authentication.mdx (+67 -0)
apps/documentation/pages/developers/public-api/index.mdx (+22 -0)
apps/documentation/pages/developers/public-api/versioning.mdx (+18 -0)

...and 80 more files

📄 Description

Description

Changes Made

  • Change 1
  • Change 2
  • ...

Testing Performed

  • Tested feature X in scenario Y.
  • Ran unit tests for component Z.
  • Tested on browsers A, B, and C.
  • ...

Checklist

  • I have tested these changes locally and they work as expected.
  • I have added/updated tests that prove the effectiveness of these changes.
  • I have updated the documentation to reflect these changes, if applicable.
  • I have followed the project's coding style guidelines.
  • I have addressed the code review feedback from the previous submission, if applicable.

Additional Notes

Summary by CodeRabbit

  • Documentation

    • Enhanced project README for clarity and improved environment variables section.
    • Added comprehensive developer and user documentation, including guides on local development, public API, self-hosting, and compliance standards.
    • Introduced specific guides for contributing, creating API keys, using webhooks, and setting up security measures.
    • Detailed documentation on various fields available for document signing to improve user understanding.
    • Added metadata structuring to improve navigation within the documentation site.
  • Chores

    • Updated .gitignore to better handle project files.
  • New Features

    • Introduced detailed metadata and documentation for various Documenso functionalities, including signing documents, user profiles, and compliance levels.
    • Added functionality for Direct Link Signing, enabling easy sharing for document signing.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/documenso/documenso/pull/1101 **Author:** [@catalinpit](https://github.com/catalinpit) **Created:** 4/11/2024 **Status:** ✅ Merged **Merged:** 7/22/2024 **Merged by:** [@ElTimuro](https://github.com/ElTimuro) **Base:** `main` ← **Head:** `feat/create-documentation-site` --- ### 📝 Commits (10+) - [`5799e36`](https://github.com/documenso/documenso/commit/5799e366d14a9f0faa23120f27180261d33eee21) feat: documentation site - [`b105be2`](https://github.com/documenso/documenso/commit/b105be2305d0f60db600fa56c5569b67de32ab5a) fix: invalid key - [`23c4054`](https://github.com/documenso/documenso/commit/23c4054d23f98d17dd6b93662e1edd1081bb64f0) fix: app name - [`24ed73e`](https://github.com/documenso/documenso/commit/24ed73ef3ee9e1063ff54ed729d5effa4c6b049e) chore: add package.json commands - [`df699e8`](https://github.com/documenso/documenso/commit/df699e890cb4ad70e9ed452c1b04a98bdae221f3) chore: added content and updated settings - [`1f71baa`](https://github.com/documenso/documenso/commit/1f71baaffb1ba6153931c16dcb241707417f8ab1) chore: some changes - [`c29e6ea`](https://github.com/documenso/documenso/commit/c29e6ea861c1227751723607e17a3ae21c511d8c) chore: added frontmatter plus some changes - [`86df82d`](https://github.com/documenso/documenso/commit/86df82dc9ff9adce2318ffcf7851377e5c6f1787) chore: hide home from nav - [`bd82d46`](https://github.com/documenso/documenso/commit/bd82d46ecd12f2b10277045c21c1d02e0903d4f4) chore: add contributing guide - [`2ed4cb6`](https://github.com/documenso/documenso/commit/2ed4cb636b9cff2b6266d0f3eec396811812b7ea) chore: improved contributing copy ### 📊 Changes **143 files changed** (+6244 additions, -68 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+11 -15) ➕ `apps/documentation/.gitignore` (+36 -0) ➕ `apps/documentation/README.md` (+36 -0) ➕ `apps/documentation/next.config.js` (+17 -0) ➕ `apps/documentation/package.json` (+35 -0) ➕ `apps/documentation/pages/_app.mdx` (+10 -0) ➕ `apps/documentation/pages/_meta.json` (+34 -0) ➕ `apps/documentation/pages/developers/_meta.json` (+16 -0) ➕ `apps/documentation/pages/developers/contributing.mdx` (+117 -0) ➕ `apps/documentation/pages/developers/index.mdx` (+18 -0) ➕ `apps/documentation/pages/developers/local-development/_meta.json` (+7 -0) ➕ `apps/documentation/pages/developers/local-development/gitpod.mdx` (+10 -0) ➕ `apps/documentation/pages/developers/local-development/index.mdx` (+63 -0) ➕ `apps/documentation/pages/developers/local-development/manual.mdx` (+77 -0) ➕ `apps/documentation/pages/developers/local-development/quickstart.mdx` (+66 -0) ➕ `apps/documentation/pages/developers/local-development/signing-certificate.mdx` (+61 -0) ➕ `apps/documentation/pages/developers/public-api/_meta.json` (+5 -0) ➕ `apps/documentation/pages/developers/public-api/authentication.mdx` (+67 -0) ➕ `apps/documentation/pages/developers/public-api/index.mdx` (+22 -0) ➕ `apps/documentation/pages/developers/public-api/versioning.mdx` (+18 -0) _...and 80 more files_ </details> ### 📄 Description ## Description <!--- Describe the changes introduced by this pull request. --> <!--- Explain what problem it solves or what feature/fix it adds. --> ## Related Issue <!--- If this pull request is related to a specific issue, reference it here using #issue_number. --> <!--- For example, "Fixes #123" or "Addresses #456". --> ## Changes Made <!--- Provide a summary of the changes made in this pull request. --> <!--- Include any relevant technical details or architecture changes. --> - Change 1 - Change 2 - ... ## Testing Performed <!--- Describe the testing that you have performed to validate these changes. --> <!--- Include information about test cases, testing environments, and results. --> - Tested feature X in scenario Y. - Ran unit tests for component Z. - Tested on browsers A, B, and C. - ... ## Checklist <!--- Please check the boxes that apply to this pull request. --> <!--- You can add or remove items as needed. --> - [ ] I have tested these changes locally and they work as expected. - [ ] I have added/updated tests that prove the effectiveness of these changes. - [ ] I have updated the documentation to reflect these changes, if applicable. - [ ] I have followed the project's coding style guidelines. - [ ] I have addressed the code review feedback from the previous submission, if applicable. ## Additional Notes <!--- Provide any additional context or notes for the reviewers. --> <!--- This might include details about design decisions, potential concerns, or anything else relevant. --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Enhanced project README for clarity and improved environment variables section. - Added comprehensive developer and user documentation, including guides on local development, public API, self-hosting, and compliance standards. - Introduced specific guides for contributing, creating API keys, using webhooks, and setting up security measures. - Detailed documentation on various fields available for document signing to improve user understanding. - Added metadata structuring to improve navigation within the documentation site. - **Chores** - Updated `.gitignore` to better handle project files. - **New Features** - Introduced detailed metadata and documentation for various Documenso functionalities, including signing documents, user profiles, and compliance levels. - Added functionality for Direct Link Signing, enabling easy sharing for document signing. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
kerem 2026-02-26 19:33:02 +03:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/documenso#1387
No description provided.