📚 "Additional Resources" Section

Open
#157 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start by reviewing the existing Blog section and the old XState Resources page linked in the issue. Read Docusaurus's multiple-blogs documentation and compare possible approaches for separate resource pages, metadata tags, search organization, and embedding resources; done means a decided structure and an updated, curated resources section.

Written by the indexing model from the issue text.

Description

In addition to documenting the features of XState, we should provide a curated list of external resources related to state machines. The old XState docs have their own "Resources" section, but this list is pretty outdated.

GOALS

  • Similar to the "Blog" section, each resource should have its own page so that they can be easily indexed and organized.
  • Resource posts should include metadata tags so that users can easily search by medium / topic (e.g. book or statechart).
    ** Docusaurus should support multiple blogs but I am still researching alternative ideas.
  • Whenever possible, resources should be embedded in the page so that users don't have to leave the docs site.

NOTES:

  • ✅ I am willing to contribute to this
Dominant language
MDX
Stars
38
Forks
93
Avg merge
19h 31m
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

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.

More from statelyai/docs

All issues in statelyai/docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.