Comments (9)
Relates to #51.
from mockyeah.
@ryanricard Would you prefer Gitbook hosted in this repo, or external repo? We might move to monorepo for the CLI, etc.
from mockyeah.
I am fine with either, monorepo may be easier to manage in the short term. i.e. feature and documentation changes included in same pull requests.
from mockyeah.
@AndersDJohnson I can take over the documentation writing now that we have GitBook deployed. I am pretty busy this weekend, but should be able to make progress next week. Thoughts?
from mockyeah.
@ryanricard That's cool. I can do some of it too if you like.
from mockyeah.
Thoughts on information architecture? I like the API Reference section on https://redux.js.org/, Lodash documentation is similar providing immediate visibility to the api.
Thoughts on the following layout? Anything missing? Or any changes that come to mind?
- Introduction
- Getting started
- API
- Service API
get()
patch()
post()
put()
delete()
record()
play()
- Expectation API
.expect()
.expect().body()
.expect().count()
.expect().header()
.expect().once()
.expect().params()
.expect().twice()
.expect().thrice()
.expect().verify()
- Classes
Server
- Service API
- Recipes/Examples
- CLI
from mockyeah.
@ryanricard That information architecture looks like a good start. I do like the visibility of the API methods.
from mockyeah.
Relates to #5.
from mockyeah.
@ryanricard Most of the methods (get
, post
, put
, patch
, delete
) you have under "Service API" have identical function signatures. Does it still make sense to have separate pages documenting them?
from mockyeah.
Related Issues (20)
- feat: auto-generate random mocked response from schema
- feat(fetch): dynamic record & play, talk to admin server HOT 1
- feat(fetch): XHR mocking
- feat(fetch): record to local storage
- feat(fetch): dynamic mock suite resolve
- Questions, multi-server, example, inspiration HOT 4
- feat(fetch): graphql mocking
- Contributing: lerna bootstrap HOT 2
- feat: create a PollyJS bridge package
- feat: create a Nock bridge package
- feat(fetch): optionally echo mocked request to service worker HOT 1
- chore(docs): move to netlify HOT 2
- feat(fetch)!: match request as function
- feat(fetch): multiple mocks per match w/ priority
- feat(fetch): echo suite & fixture as response header
- feat(fetch): optional modify request pre-match
- Proposal: Switch to `cross-fetch` instead of `isomorphic-fetch` HOT 2
- feat: Export type information HOT 2
- Website nav has extra breaks on firefox
- Mockyeah server filepaths not found HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from mockyeah.