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

New design doc #283

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

New design doc #283

wants to merge 5 commits into from

Conversation

marceline-cramer
Copy link
Collaborator

@marceline-cramer marceline-cramer commented Jan 13, 2024

Closes #138.

An incomplete design document is better than an outdated one. Besides, if I were capable of completing this on my own, it would have happened in the months that I've been trying to do this. I need help. This new design document is basically solely responsible for blocking the search for more public Hearth engagement.

Let's polish and then merge an incompete draft of the design document, then open a megaissue to coordinate the work on each individual section and who is able to complete them. Divide and conquer.

I'm not sure how many of the drafting notes and comments in this draft we should keep, or how many we should maintain as help to whoever fleshes out each incomplete section. However, I do think that we should make a reasonable (i.e. let's not let this take four more months) polishing pass on what I've written so far before we put it in the main branch.

I've put the new design document in a dedicated file (NEW_DESIGN.md) in order to avoid diffing it against the old design document to ease the review process. Once the design document is approved by everyone, I'll make one final commit to overwrite DESIGN.md with NEW_DESIGN.md and merge it.

Please leave a comment if you have any questions or suggestions about this drafting process.

@marceline-cramer marceline-cramer added enhancement New feature or request host Deals with host side code complex High difficulty to accomplish labels Jan 13, 2024
the Hearth VM, access to native resources such as audio and graphics, and most
importantly, the execution environment for **guests**.

> TODO: rephrase this ^^^ paragraph to target established audience knowledge level better
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestions welcome!

Hearth is an always-on execution environment for building 3D virtual worlds
from the inside.

> TODO: bring the new tagline in here!
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably going to leave this for now.

large userbase in the modern era. Proprietary virtual worlds software will not
stay feasible forever.

> TODO: *how* is the Fediverse an improvement? how is federation the future?
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Erlend linked some really cool articles on the Discord server that we may be able to incorporate here. Thoughts?

@airidaceae
Copy link
Collaborator

I think this is an amazing idea. Ill review when i get the chance

@marceline-cramer marceline-cramer added documentation Improvements or additions to documentation and removed host Deals with host side code labels Jan 14, 2024
There is clearly room for contemporary virtual world platforms to grow. So,
where do we go from here?

> TODO: are rhetorical questions out of style? direct statement about Hearth being where we go from here?
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that rhetorical questions are out of style for a design document.

@Meister1593
Copy link
Contributor

Design document definitely needs to contain what coordinate system Hearth has, as every single asset and translation/movement code has to be based off that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
complex High difficulty to accomplish documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation
3 participants