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

list of suggestions from knar #4

Open
madjin opened this issue Feb 23, 2024 · 2 comments
Open

list of suggestions from knar #4

madjin opened this issue Feb 23, 2024 · 2 comments

Comments

@madjin
Copy link
Member

madjin commented Feb 23, 2024

  • pass through of all text for grammar, clearness etc
  • overview could have links to other sections, description of everything the docs have to offer
  • add some more questions to FAQ
  • mobile controls screenshot/diagram
  • move the content of the "overview" pages into the "folder" of it's section (one less click, 2 less taps on mobile)
  • world owners overview - emphasize ! SAVING CHANGES MANUALLY !
  • explain how to publish world, explain it is separate from the other save button
  • how to bring up performance menu?
  • apps/app guides
  • sample app world link (hyperfy academy?)
  • screenshot of how to do the stuff in blender?
  • emotes
  • finish optimization page
  • avatars guide
  • zip files are kinda sketchy lol gh page seems better
  • developer folder page links to sub pages
  • make sure all the developer tutorialsl/code samples work
  • add samples of complex apps
  • link to open source repo of apps
  • document any missing stuff from the API (maybe hidden features?)
  • document any other features missing from the docs or at least add a stub for them
@madjin
Copy link
Member Author

madjin commented Mar 23, 2024

updated list

  • add anything missing from api docs
    • useFields() all options are not documented, no way to know what they are
    • global explain global vs local coordinate space
    • animations on sdk models
    • useSignal/useTrigger
    • onjoin returns avatar, but other events return event? need to somehow show which callbacks get which
    • audio has no .position prop
  • add code samples to components
  • add code samples to refs
  • pass through code samples again
    • fix any code samples with to
    • make sure samples are consistent, swap out any samples using console.log
  • normalize everything to be tables (easier to read)
  • add Ray ref page
  • add hit ref page
  • rearrange sidebar
  • move secrets into its own file
  • consolidate quickstart, use code summaries to shorten it
  • Fridge guide
  • add slot machine to hyperfy-recipes
  • FAQ questions
    • headset specific questions
    • world failed to load
    • best way to host a stream
  • when to use the sdk?
    • sdk superpowers
      • make HTTP requests - call APIs
      • create cameras that can used for cinematics
      • read/write to a contract
      • sign eth messages
      • analyse audio and do something with the frequency data (3d visualizers)
      • generate random numbers
      • generate pseudorandom numbers from a seed
      • dynamically control lights
      • raycast
      • user text inputs in world
      • group things and scale/rotate/position them together
      • change tone mapping of world
      • create billboards
  • questions
    • does ash know of anything missing from the docs?
    • is recommended version still accurate?
    • events, is there a difference between world events and broadcast events. Are they all cross-app?
    • is .off supposed to have a callback?
    • args for event broadcast functions?
    • how to cast ray and get hit with an arbitrary direction/location?

@emmz3230
Copy link

hi will love to help check all the requirements listed above for your documentation site. I would love to discuss this further

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

No branches or pull requests

2 participants