#532 Website Documentation Feedback 1

Greg Ingram Mon 4 Sep 2017

This is my first set of improvements I see that need to be reviewed in the protocol's documentation. I'll try to add more along the way. Thanks.

Json Page

http://project-haystack.org/doc/Json

  • Misspelling in Type Mapping section: DateTime has requrired timezone name

Trio Page

http://project-haystack.org/doc/Trio

  • Wording in Overview: It the primary format for authoring the tag definitions on the Project Haystack site itself. Should be "It is the".
  • Misspelling in Simple Example Summary: This is a string value which spans multiple lines with one or more space characgter

Operations Page

http://project-haystack.org/doc/Ops

  • Wording in Overview section: "Each operation is specifies the format and options of the request grid and response grid." Should remove "is".
  • Misspelling in Formats section: "The formats op is used to query which MIME types are availble to read and write grids."
  • Wording in Formats section: "send: Marker tag is server can write this format in responses (client can request response in this format)". Should be "if" instead of "is" similar to description in receive property.
  • Wording in InvokeAction section: "The invokeAction op is used to invoke an user action on a target record.". Should be "a user".
  • Wording in WatchSub section: "Request: a row for each entity to subscribe to with the an id column and Ref values. Should remove "the" or "an".
  • Wording in WatchSub section: "watchDis: Str debug string required when creating a new watch". Should "debug" be "display"?
  • Wording in WatchUnSub section: "close: Marker tag to close the entire watch The request also ." Appears the sentence is not completed, but not sure what it should state.

Brian Frank Tue 5 Sep 2017

Thanks for taking the time to post those errors Greg. I pushed a fix for next website release

Login or Signup to reply.