Skip to content
This repository has been archived by the owner on Aug 21, 2024. It is now read-only.

Reinstate the ordering of the example contracts. #720

Closed
wants to merge 2 commits into from

Conversation

ElliotFriend
Copy link
Contributor

The ordering is intentional so as to give folks a basic understanding before moving on to more complex topics. I've re-created the order here that existed previously.

Closes #717

@leighmcculloch Here's a first stab at this. I re-did the order in your screenshot, since the reorg also did away with the folders for {basic,advanced}-tutorials. The only one that wasn't there at that time was the Fuzzing example. That's tacked on at the end of the list for the time being, is there a better place to put it within the order? I was thinking maybe after Allocator? Is the note I added at the top of the Tutorials page enough to explain the idea, or should we do something else to communicate that there is an intended order to these things?

Also, honest question: What are your thoughts on the way we have the tutorials listed now (As one list that's filter-able and searchable)? The main goal was to "un-clutter" the sidebar, and display them in a more convenient way. Is it useful? Is it harmful? I just want to make sure I'm not blinded by being "too close" to the feature and just assuming it's great lol

The ordering is intentional so as to give folks a basic understanding
before moving on to more complex topics. I've re-created the order
here that existed previously.
@stellar-jenkins
Copy link

@tupui
Copy link
Contributor

tupui commented Feb 14, 2024

As a person who raised it on Discord, thank you 😅

The description is good to me. To make it even clearer, I would suggest that in the dropdown instead of 'All', we could have 'Recommended order'.

Besides that, what I personally have missed is a 'how to read this doc'. Because it can be difficult otherwise to get why some concepts are presented a few times: tutorials, guides and also internals. There is a small description at the end of the quick start guide, but it's mostly just a listing.

Also I think that the internal section should appear before the tutorials (would rename this to example contracts maybe, or as to follow Rust's naming: Soroban by examples) and guides.

Sorry for shooting in multiple directions with my comment 😅 Happy to help in any ways if wanted.

@leighmcculloch
Copy link
Contributor

Speaking from my own experience, I think the drop down for level of difficulty gets in the way, and it's jarring changing from the all list where everything is jumbled together to it. I think we could communicate the same information with the list of tutorials being static with headings above each group with beginner, etc. Wdyt?

@tupui
Copy link
Contributor

tupui commented Feb 14, 2024

If the list is static, you could also show the level with a sort of label/flag close to the title.

@stellar-jenkins
Copy link

@ElliotFriend
Copy link
Contributor Author

@leighmcculloch @tupui Hi, there, gentlemen!

Sorry to let this PR and its issue get so stale! In the process of migrating everything over to the stellar-docs repo, here's what I've done to this listing of example contracts:

  1. re-ordered them according to the same order we used before. they're in a more crawl -> walk -> run order, and i've added a note on the "README" page to describe that, too.
  2. i've done away with the filtering/searching bits. if we had a couple dozen example contracts listed, those features might make more sense. as it is now, it felt like they just got in the way.

For now, there's not really any (displayed or otherwise) distinction made between "beginner," "intermediate," etc. I think the dividing lines for our set of examples is a bit too "blurry" for it to really provide much meaningful information. Perhaps there's room to implement something like the headings you guys mentioned in the future, but for now, i think going back to (basically) the way it was is the best option.

I'm gonna close this PR and the issue as soon as we've got stellar/stellar-docs#388 merged. Thanks again for your help and insight, guys!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reorder tutorials to make a clear path to the most important and simplest topics first
4 participants