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

[EPIC] Build Section #413

Closed
wants to merge 7 commits into from
Closed

[EPIC] Build Section #413

wants to merge 7 commits into from

Conversation

mattyg
Copy link
Member

@mattyg mattyg commented Jan 8, 2024

This is the main PR to contain many smaller PRs, before they can be merged into main.

Overview

  • Rename "Core Concepts" to "Learn"
  • Add top-level section "Build"
    • Content will focus on practical developer usage of holochain, with less prose, more code examples, and links directly into rust docs

@pdaoust
Copy link
Collaborator

pdaoust commented Feb 26, 2024

I like the idea of calling the new section 'build'. Fits for me. I have to confess I'm emotionally attached to the term 'core concepts', but I'm willing to change it if it's getting in the way. What's the reason for changing it to 'learn'? Consistency?

I'm also seeing a need for howtos like 'distribute your app', 'Holochain upgrade 0.1→0.2', and 'Setup for a local event', which really shouldn't be in 'get started'. 'Resources' makes sense for most of them, except that 'distribute your app' feels like a build (or rather, post-build) topic. Seems there's two types of content that might show up in 'build':

  • topical / encyclopedic content like your PRs on entries and links
  • howtos

I've got a proposal for an IA reorg but I want to hear your ideas too:

  • Get started
    • Install
    • Scaffold a Hello World demo
    • Scaffold a forum from scratch
    • other get started pages (dev tools setup tips, setup without nix, etc)
  • Learn
    • [... all the Core Concepts in here ...]
  • Build
    • Architecting a hApp (explanation of code organisation / modularity primitives, with examples of using the hc tool and folder structure)
    • Using the HDI and HDK
      • Working with entries
      • Working with links
      • etc
    • Other buildy topics (connecting a client to your hApp, etc)
  • Resources (just noticed this is called 'resources' in the top nav and 'references' in the side nav)
    • Links out to (or embeds of) reference guides
    • Howtos
    • Glossary
  • Get involved

@mattyg
Copy link
Member Author

mattyg commented Mar 3, 2024

I like the idea of calling the new section 'build'. Fits for me. I have to confess I'm emotionally attached to the term 'core concepts', but I'm willing to change it if it's getting in the way. What's the reason for changing it to 'learn'? Consistency?

I guess consistency and just copying language from other documenation sites, but it's not important to me -- I'd defer to you.

I'm also seeing a need for howtos like 'distribute your app', 'Holochain upgrade 0.1→0.2', and 'Setup for a local event', which really shouldn't be in 'get started'. 'Resources' makes sense for most of them, except that 'distribute your app' feels like a build (or rather, post-build) topic. Seems there's two types of content that might show up in 'build':

I don't think these are resources. To me resources are either external links (i.e. to libraries), or api reference docs. Knowing how to upgrade and distribute an app is critical info in the app development process. If we don't want to keep it in build, then maybe it deserves its own section "App Lifecycle" or something.

@pdaoust
Copy link
Collaborator

pdaoust commented Mar 4, 2024

Thanks on both counts -- your second point resolves a quandary I was just chewing on, in fact (where to put howtos like deployment, upgrade, etc)

@pdaoust
Copy link
Collaborator

pdaoust commented Mar 22, 2024

Closing because #436 deals with the CC renaming, and the Build section will automatically get created once we create our first page in that section.

@pdaoust pdaoust closed this Mar 22, 2024
@pdaoust
Copy link
Collaborator

pdaoust commented Mar 22, 2024

actually I created a skeleton in #437 without any actual individual pages.

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