I have wip in progress that conflicts with these secondary reviews. Hence this reminder issue.
Workspace
[x] Replace: All techniques above still apply, but you will instead, for example:
With: All techniques above still apply, but you will instead create a workspace like so:
(With the idea it will probably be easier to grok for folks whose first language is not English.)
Component
[x] General -> Specific for:
Joakim: On the component page, I think we can leave out :extra-deps from "IDE Support for :local/root" because it's only :local-root that the IDEs have problem with
Lee: Technically true, I was just following the spirit of the original text. But I think this would be an improvement.
The content should would also need to be tweaked a tiny bit to state the general issue before moving on to the specific.
Example, Production Systems
[x] In the tip at the top of example-systems, we could mention that the individual three diagrams in each image can be generated by the info, deps, and libs commands that we will cover later.
Dev docs
[x] Mention InkScape is used for doc diagrams.
Convention of saving .svg next to .png.
Use cross-platform fonts (I think installing Microsoft fonts should be enough).
[x] Mention SNAPSHOT check behavior.
Doc
[x] The link "Different versions" does not work.
General
[x] do not -> don't
We'll prefer don't in general. Might also add note to dev docs on docs.
[x] We've decided on "argument" instead of "parameter". I'll swing back to documents I've already edited and make the change, otherwise I'll handle this as I progress sequentially through docs.
[x] Add (1), (2)...numbering (adoc code callouts) to the code examples in already reviewed pages, like near "Your workspace directory structure" and "Let’s listen to the helpful reminder" in component.adoc.
[x] Describe the tutorial example in some detail very early in the docs.
Then we can link back to that description from later tips.
From chat on Slack with @tengstrand:
I have wip in progress that conflicts with these secondary reviews. Hence this reminder issue.
Workspace
Component
Example, Production Systems
info
,deps
, andlibs
commands that we will cover later.Dev docs
[x] Mention InkScape is used for doc diagrams. Convention of saving .svg next to .png. Use cross-platform fonts (I think installing Microsoft fonts should be enough).
[x] Mention SNAPSHOT check behavior.
Doc
General
[x] do not -> don't We'll prefer don't in general. Might also add note to dev docs on docs.
[x] We've decided on "argument" instead of "parameter". I'll swing back to documents I've already edited and make the change, otherwise I'll handle this as I progress sequentially through docs.
[x] Add (1), (2)...numbering (adoc code callouts) to the code examples in already reviewed pages, like near "Your workspace directory structure" and "Let’s listen to the helpful reminder" in component.adoc.
[x] Describe the tutorial example in some detail very early in the docs. Then we can link back to that description from later tips.