Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation considerations #2867

Closed
16 tasks done
chasenlehara opened this issue Dec 8, 2016 · 0 comments
Closed
16 tasks done

Documentation considerations #2867

chasenlehara opened this issue Dec 8, 2016 · 0 comments
Assignees
@chasenlehara
Labels
developer relations p1

Comments

@chasenlehara
Copy link
Member

chasenlehara commented Dec 8, 2016 •
edited
Loading

Some things I’m going to look into improving:

Quick Fixes:
  • “other computed computed libraries” in Cool Computes
  • Reword “are mostly written using just two and a half APIs:”
  • Fix the “within the element with an instance of their” wording
  • Fix “this template, and add” in the TodoMVC Guide
  • Reword “List todos from a list of todos” in the TodoMVC Guide
  • Change id: "string" to id: "number" in the TodoMVC Guide
  • “forward and backwards button” => “browser forward and backwards buttons”
Chat Guide:
  • Mention serialize: false in the JavaScript code description in the Chat Guide’s “Route between two pages” section
  • Mention two-way binding in the Chat Guide’s “Route between two pages” key take-away
  • Mention messagesPromise before it’s used in the “List Messages” HTML
  • Add an “Explanation” section under “List Messages” so the “This adds methods” section is split from the code-copying part.
  • Improve the key take-away under the Chat Guide’s “List Messages” section to mention that we’re modeling the schema/type info and also connecting to a service
TodoMVC Guide:
  • Introduce set.Algebra before it’s first used
  • Explain the {($checked)} syntax before it’s used in the TodoMVC Guide
  • Explain the ($click) syntax before it’s used in the TodoMVC Guide
  • Improve the wording of the “In this section, we will” points in the TodoMVC Guide’s “List Todos” section
@chasenlehara chasenlehara self-assigned this Dec 8, 2016
@chasenlehara chasenlehara added the p1 label Dec 8, 2016
chasenlehara added a commit that referenced this issue Dec 12, 2016
@chasenlehara
Fix various documentation issues
66a76e3 
Related to #2867
chasenlehara added a commit that referenced this issue Dec 12, 2016
@chasenlehara
Fix the Todo id type in the TodoMVC examples
03eeedc 
Related to #2867
chasenlehara added a commit that referenced this issue Dec 13, 2016
@chasenlehara
Fix some issues in the TodoMVC guide
7d53678 
The biggest change in this commit is not using the generic API names in the descriptions that appear before the code changes.

Here’s an example of a sentence that appeared previously:

> Use `{{#each expression}}` to loop through every todo.

With this commit, the following is displayed:

> Use `{{#each todos}}` to loop through every todo.

The code still links to the API docs and it makes it easier for readers to connect the sample code with the description.

Related to #2867
chasenlehara added a commit that referenced this issue Dec 13, 2016
@chasenlehara
Fix some issues in the Chat guide
8c6cab4 
Related to #2867
@chasenlehara chasenlehara mentioned this issue Dec 13, 2016
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@chasenlehara chasenlehara

Labels
developer relations p1
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@chasenlehara