thefrontside / thefrontside/effection

Reorganize Effection Documentation

Open
#883 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
856
Forks
39
Avg merge
2d 8h
Merged PRs (30d)
8

Description

I was reading through the effection v3 docs and had some ideas on better organizing its content:

Getting Started

This section should be reserved for content that prepares the readers for learning Effection. We want our users to be able to read top down without without having to jump back and forth forward and back so it would make more sense to put Typescript lower as it discusses Operations before it's been introduced, and the same goes for the current fetchWeekDay tutorial in the Tutorial page.

This is also where we can add the new FAQ page (#811).

Learn Effection

In the Learn Effection section, I'm proposing the following changes:

  • Add an Overview page - this will be our "How to navigate these docs" page and provide a high level overview of the different components of Effection
  • Group guides together by adding dividers - I think the dividers could help give readers a breathing spot in their journey of learning Effection
  • Create a single page for race(), sleep(), all(), call(), ensure(), and whatever else
    • I chose Utilities as a placeholder but we can call it something else
Scope

Other than the Overview page, each page should introduce a new API for consistency so I'm still trying to figure out where the best place would be for Scope. We could first introduce the Three Outcomes section of Scope in Operations and sprinkle the rest in as we introduce more APIs. This way users can learn more about scopes incrementally.

TL;DR

I think it would also be very helpful if each page started with a TL;DR that explains when a user needs to use {x}. If we decide to create an Overview page, we could take the short descriptions we write for the high level overview and just paste it into the TL;DR sections.

Tutorials

And in this section, we can put all the How-Tos. I think this place would be the logical place to put Typescript and Error Handling as neither of these pages introduces any new Effection APIs and by the time the readers get to the tutorial section, they will have already read up on main/run, spawn, suspend, and know what an Operation is.

We may want to create a separate section for Examples down the road but I think we can just put everything into Tutorials for now.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the current Effection v3 documentation navigation and the pages named in the issue, including Getting Started, Learn Effection, Tutorials, Typescript, and Error Handling. Done means an agreed information architecture that places the pages and APIs coherently, adds the proposed Overview and TL;DR content, and records where Scope and the FAQ belong.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.