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

Minor edits to dev journeys section titles and indexes #198

Open
wants to merge 2 commits into
base: staging
Choose a base branch
from

Conversation

lparisc
Copy link
Contributor

@lparisc lparisc commented Jul 31, 2023

@lparisc lparisc requested a review from nsjames July 31, 2023 07:57
@lparisc lparisc self-assigned this Jul 31, 2023
@lparisc lparisc changed the title Rename first section in journeys to basics, minor edits Minor edits to dev journeys section titles and indexes Jul 31, 2023
@nsjames
Copy link
Member

nsjames commented Jul 31, 2023

Anatomy != basics

The anatomy talks about the actual composition of contracts & structures

@@ -1,21 +1,18 @@
---
title: Beginner Concepts
title: Web App Basics
Copy link
Member

Choose a reason for hiding this comment

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

Don't need to re-state "Web app", it's already in the web app section

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I removed the "web app" phrase. Back in the day they asked to make sure the actual related topic appeared on the title, for indexing and search matching reasons. If the title is just "Basics" the indexer must somehow used context from the parent to figure out what basics it refers to - probably something a good search engine will do anyway. I was just making it easier for the indexer, although probably not needed, so removed.

@@ -0,0 +1,11 @@
---
title: Getting Started
Copy link
Member

Choose a reason for hiding this comment

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

Is it meant to be getting started, or basics?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When learning a new technology you typically start with the basics, so I think they can be used interchangeably. Basics is more concise. I can change it back to getting started though, just let me know.

@lparisc
Copy link
Contributor Author

lparisc commented Jul 31, 2023

Anatomy != basics

The anatomy talks about the actual composition of contracts & structures

I changed it back to Anatomy. However, I think "anatomy" is a bit unusual in a technical context to describe the structure or composition of something - it's also used in biology and medicine. This section covers the basics of smart contracts which involves their structural components too. It's also the first section within the smart contract journey, so it's expected. Anyways...

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