WIP feat: hocuspocus docs #237
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* added cta bar * added CTA bar for stable docs
Fix search icon transparency
* bug: adjust preserve-images example to v2 import * v1 and v2 example
…nto-view-if-not-visible Feature/scroll-sidebar-link-into-view-if-not-visible
fix: add padding after last sidebar menu item
…l-behaviour fix: add padding after last sidebar menu item
fix: improve feedback component layout and footer stability on all de…
Feature/docs feedback
* fix: do not convert the response to json in the code example if the response format is not json * fix: remove unnecessary optional chaining operators because response is never null or undefined. * fix: convert response to json when it is json * fix: remove line break
…tion-docs Add documentation for emitContentError property
…tion-docs-cherrypick-main Add documentation for emitContentError property (cherry-pick)
…improvements Feature/subscription callout improvements
…improvements Additional tag adjustments
Added checkllist component and adjusted content
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds initial documentation for the Hocuspocus collaboration server, including navigation updates and placeholder content for future guides.
- Introduce new docs pages under
content/hocuspocus/getting-started - Configure sidebar entries for the Hocuspocus section
- Update the main product dropdown to include Hocuspocus
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/content/hocuspocus/sidebar.ts | Added sidebar entries for Hocuspocus docs |
| src/content/hocuspocus/getting-started/template.mdx | Stubbed auth guide template |
| src/content/hocuspocus/getting-started/sponsor.mdx | Added sponsor page content |
| src/content/hocuspocus/getting-started/overview.mdx | Created overview documentation |
| src/content/hocuspocus/getting-started/install.mdx | Added installation guide |
| src/content/hocuspocus/getting-started/contributing.mdx | Added contributing guide |
| src/components/ProductDropdown.tsx | Included Hocuspocus in the product dropdown |
Comments suppressed due to low confidence (3)
src/content/hocuspocus/getting-started/contributing.mdx:32
- Ordered list items have inconsistent numbering (1, 3, 4, 3, 4...); use sequential numbering or use
1.for all items so Markdown auto-numbers correctly.
1. Copy the code to your local machine: `$ git clone [email protected]:ueberdosis/hocuspocus.git`
src/content/hocuspocus/getting-started/template.mdx:9
- There's a second frontmatter block for
tableOfContents; merge it into the main block to avoid parsing issues.
---
src/content/hocuspocus/sidebar.ts:29
- [nitpick] The 'Authenticate and authorize in Collaboration' template page isn't included in the sidebar; consider adding it or removing the placeholder.
],
|
|
||
| If you want to include a local hocuspocus package in your project, you'll need to follow the following steps. I have tried using `npm link`, but haven't managed to make it work reliably because of duplicated yjs imports. The following is the only way I made it work: | ||
|
|
||
| Execute the following command in this (hocupsocus) repo to compile the sources: |
There was a problem hiding this comment.
Typo in 'hocupsocus'; it should be 'hocuspocus'.
Suggested change
| Execute the following command in this (hocupsocus) repo to compile the sources: | |
| Execute the following command in this (Hocuspocus) repo to compile the sources: |
Copilot uses AI. Check for mistakes.
arnaugomez
requested changes
Jun 12, 2025
| tableOfContents: true | ||
| --- | ||
|
|
||
| # text comes here |
|
|
||
| ### I want consulting. What’s your rate? | ||
|
|
||
| If you have an issue, a question, want to talk something through or anything else, [please use GitHub issues](https://github.com/ueberdosis/hocuspocus/issues) to keep everything accessible to the whole community. For everything else, reach out to [[email protected]](mailto:[email protected]). We can take on a limited number of custom development and consulting contracts. |
There was a problem hiding this comment.
Consider linking the "Contact sales" page instead of our mail: https://tiptap.dev/contact-sales
|
@janthurau if it's wip put the PR as draft |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.