-
Notifications
You must be signed in to change notification settings - Fork 18
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.
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
DOC Provide proper developer documentation #224
Conversation
docs/en/08_gotchas.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file and the migrating dir intentionally have late-numbered prefixes. This allows future pages to be added before them without having to rename them.
docs/en/09_migrating/00_upgrading.md
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This and all other migrating/upgrading docs are unaltered, since updating these guides is going to be handled in a separate card.
93fa304
to
280de69
Compare
docs/en/03_templates.md
Outdated
<% if $HasManyLinks %> | ||
<ul> | ||
<% loop $HasManyLinks %> | ||
<li>$Me</li> | ||
<% end_loop %> | ||
</ul> | ||
<% end_if %> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
<% if $HasManyLinks %> | |
<ul> | |
<% loop $HasManyLinks %> | |
<li>$Me</li> | |
<% end_loop %> | |
</ul> | |
<% end_if %> | |
<% if $HasManyLinks %> | |
<ul> | |
<% loop $HasManyLinks %> | |
<li>$Me</li> | |
<% end_loop %> | |
</ul> | |
<% end_if %> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
docs/en/03_templates.md
Outdated
<ul> | ||
<% loop $HasManyLinks %> | ||
<li> | ||
<a href="$URL" <% if $OpenInNew %>target="_blank" rel="noopener noreferrer"<% end_if %>>$Title</a> | ||
</li> | ||
<% end_loop %> | ||
</ul> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
<ul> | |
<% loop $HasManyLinks %> | |
<li> | |
<a href="$URL" <% if $OpenInNew %>target="_blank" rel="noopener noreferrer"<% end_if %>>$Title</a> | |
</li> | |
<% end_loop %> | |
</ul> | |
<ul> | |
<% loop $HasManyLinks %> | |
<li> | |
<a href="$URL" <% if $OpenInNew %>target="_blank" rel="noopener noreferrer"<% end_if %>>$Title</a> | |
</li> | |
<% end_loop %> | |
</ul> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
280de69
to
9f3800d
Compare
Description
Note that this PR assumes the primary place for actually viewing the docs will be from the developer docs, but makes a best-effort approach to making them usable from GitHub as well.
To this end, API links use the developer docs
api:
style, but docs to other developer docs sections use absolute URLs.Issues
Pull request checklist