Documentation Updates

[leogdion]

Heading

• There’s a typo under Features: This means Speuclid can…
• Table of contents is weird; it’s showing the whole page, where I would expect to just see the docs headings

Installation

• don’t include the comma after “go ahead”
  Once you have unzipped the file, go ahead, and copy the application Speculid.App to the Applications folder.

Usage

• “Right now… for now” (get rid of one of them)
  Right now, Speculid only supports being called through a command line terminal for now. Once you have copied the command to your /usr/local/bin folder you should be able to access it easy.
• should be “easily” not “easy”

File Format and Properties*

• change the last part to be “or an absolute path, such as:”
  All paths specified in the json file could be relative to the .speculid file or an absolute path. Such as
• include an example of both relative and absolute paths
• For all the subheadings, I would separate the label from the code better. Put the code in parentheses, like Source (source) or on the next line. Or just use the code as the subheadings. (edited)

Set

• Is there a particular file format needed for this? I’ve never used XCode except for that one workshop you did at the Apple store, so I have no idea what this is. (edited)

Source

• To be more consistent with the wording for Set, I’d say “The image source file can be a SVG or PNG file.”

Geometry

• typo in aspect ratio

Background

• “As a requirement… are required” (get rid of one)
  As a requirement, App Icons are required to exclude any alpha channels.

Exporting SVGs for Speculid

Sketch instructions

• In the top menu, select File…Export. I usually see this written as File > Export. Same with future instances of this format. (edited)

Photoshop instructions

• Open your Photoshop document, select File…Export…Export As…. this is a run-on sentence. Put a period instead of a comma or use “and”

Xcode integration

• Create the speculid file and add it to your project folder as well as your source graphic files. This is ambiguous (are you adding the speculid file to the source graphic files, or adding the source graphic files to the project folder?). I suggest: Create the speculid file and add it to your project folder, along with your source graphic files.
• You have nested lists where all levels are using numerals. Make the second level letters or something.
• In 2.4, there’s a typo in transparency
• anchor link doesn’t work
• 6. Build and Run. Done. is a little lackluster. Make it bold! Add an exclamation point! (edited)

Footer

• The site could use a little more whitespace after the end of the docs and before the footer.