Skip to content

feature: Add Docspane to Code Editor #61

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

Open
wants to merge 22 commits into
base: dev
Choose a base branch
from

Conversation

Innkeeping
Copy link
Contributor

@Innkeeping Innkeeping commented Mar 11, 2025

Description

Please include a summary of the changes and which component(s) are affected. Explain how your changes improve or modify the component's functionality within the Hyperfy ecosystem.

Adding a Docspane component that opens from Code Editor. The docs pull from a json that is created from the dev branch docs/ref api docs. It has a search feature. Closes when the inspect pane closes. It is draggable. It currently doesn't have a resize feature. But maybe when usePane includes this, we can add the capability.
Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes a component issue)
  • [ x] New component
  • [ x] Component enhancement
  • Breaking change (would cause existing worlds using this component to behave differently)
  • [x ] Documentation update

How Has This Been Tested?

Please describe your tests:

  • [ x] Component functionality tests
  • [x ] Integration tests with other Hyperfy components
  • [ x] World integration testing
  • Cross-browser testing

Test Configuration:

  • Hyperfy Version: most up to date as 3/10
  • Test world setup: localhost
  • Browser(s): brave
  • Node.js version: 22.11.0

Checklist:

  • [ x] My code follows Hyperfy's component architecture
  • [x ] I have performed a self-review
  • I have documented the component's usage
  • [ x] I have tested the component in multiple scenarios
  • [ x] My changes maintain compatibility with existing worlds
  • I have updated the component documentation if needed

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