contactually / contactually/redux-capacitor

Needs a "Getting Started" guide.

Open
#14 0 comments 0 reactions 0 assignees View on GitHub
help wanted open discussion
Dominant language
JavaScript
Stars
9
Forks
0
PR merge metrics
No merged PRs in 30d

Description

We need a good "Getting Started" markdown guide. This should guide the user through setting up redux-capacitor against an existing REST api from start to finish, detailing edge cases.

This guide should be thorough, and we need to keep in mind that we have to think of how others will use this in their apps, which may have a different setup than ours.

Let's use this thread to discuss and plan out a format & structure for the "Getting Started" guide.

Contributor guide

No contributing guide indexed for this repository

Research direction

No file, test, or entry point is named. Review the repository's existing setup and redux-capacitor usage against an existing REST API, then define a guide structure that covers setup, common variations, and edge cases; done means a complete start-to-finish Markdown guide suitable for different app setups.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
api, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.