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

Refactor/split up get started #414

Merged
merged 20 commits into from
Mar 22, 2024
Merged

Refactor/split up get started #414

merged 20 commits into from
Mar 22, 2024

Conversation

mattyg
Copy link
Collaborator

@mattyg mattyg commented Jan 8, 2024

Overview

  • split up Core Concepts > Get Started page into multiple separate pages
    • move "hello world" section to Build > Index
    • move forum tutorial section to Build > Forum App Tutorial
    • move deployment section to Build > Deployment & Packaging
    • move unique "Next Steps" content to "References" section
  • remove redundant content from Next Steps section

@mattyg mattyg requested a review from pdaoust January 8, 2024 21:20
@mattyg mattyg force-pushed the refactor/split-up-get-started branch from e232eb7 to 009f61a Compare January 8, 2024 22:36
@pdaoust
Copy link
Collaborator

pdaoust commented Feb 26, 2024

Seems like a solid move; I'd like to suggest a slight rejiggering:

  • keep it in 'Get Started'
  • have page 1 of 'Get Started' be the install guide
  • Follow with Holo World etc
  • Maybe deployment and packaging could be merged with /get-started/distribute-your-app and become a proper full-on resource. I wonder if it was out of scope for a getting started guide in the first place.

@mattyg
Copy link
Collaborator Author

mattyg commented Mar 4, 2024

keep it in 'Get Started'

But its not conceptual -- its specific to developers actually building apps. I feel like concepts should be purely for understanding holochain not using it. When someone is installing the dev tools they've moved solidly into using it.

I don't think deployment and packaging belongs in "getting stated" -- I think it deserves it's own page. There's going to be a lot more content needed related to packaging, distribution and updating.

That said I don't have the bandwidth to go back and forth, so I'm happy to let you make the changes you want to this PR and get it merged.

@pdaoust
Copy link
Collaborator

pdaoust commented Mar 4, 2024

I appreciate your engaging when you don't have much bandwidth, and I don't want to pull you away too much more. Can I ask one more question though? I'd like clarification on

But its not conceptual -- its specific to developers actually building apps. I feel like concepts should be purely for understanding holochain not using it. When someone is installing the dev tools they've moved solidly into using it.

So the way I see it, 'Get Started' is all about taking action and starting to use the dev tools (but before you're getting into serious dev work). It isn't currently under Core Concepts, though (which is 100% conceptual) -- maybe that's why the confusion?

I don't think deployment and packaging belongs in "getting stated" -- I think it deserves it's own page. There's going to be a lot more content needed related to packaging, distribution and updating.

100% agree; not sure why it's there right now.

@mattyg
Copy link
Collaborator Author

mattyg commented Mar 4, 2024

ah sorry my bad -- yes all your suggestions make sense to me

@pdaoust pdaoust force-pushed the refactor/split-up-get-started branch from e2041e2 to de96bda Compare March 11, 2024 20:31
@pdaoust pdaoust changed the base branch from feat/build-section to main March 11, 2024 21:10
@pdaoust
Copy link
Collaborator

pdaoust commented Mar 12, 2024

This looks good to me now. I would like to get a third set of eyes on it, but I'm not sure who to bring in. @matthewjosef ? @marycamacho ? The tl;dr for this change is that the getting started guide is getting broken up into four pages to make it more digestible.

@pdaoust
Copy link
Collaborator

pdaoust commented Mar 20, 2024

@matthme could you re-review the changes in the last commit, to see if I'm describing your kangaroo repos accurately? Thanks 🙏🏼

Copy link
Collaborator Author

@mattyg mattyg left a comment

Choose a reason for hiding this comment

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

I do feel like these pages probably don't belong under "Getting Started", but that can wait until we have the start of a "Build" section:

Distribute your App
Holochain Upgrade 0.1 → 0.2
Setup For a Local Event

Otherwise looks good -- so much more legible IMO.

@pdaoust
Copy link
Collaborator

pdaoust commented Mar 22, 2024

yeah, those definitely need to move @mattyg -- I was gonna wait until we had a build guide, then create a howtos section.

Although... does 'set up for a local event' feel like it belongs under build? not sure.

@pdaoust pdaoust merged commit fb44a55 into main Mar 22, 2024
6 checks passed
@pdaoust pdaoust deleted the refactor/split-up-get-started branch March 22, 2024 20:39
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.

None yet

3 participants