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.

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

Merged
merged 1 commit into from
Feb 18, 2024

Conversation

GuySartorelli
Copy link
Member

Description

  • Moves readme docs into the docs/en/ dir where it belongs
  • Adds missing docs

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

  • The target branch is correct
  • All commits are relevant to the purpose of the PR (e.g. no debug statements, unrelated refactoring, or arbitrary linting)
    • Small amounts of additional linting are usually okay, but if it makes it hard to concentrate on the relevant changes, ask for the unrelated changes to be reverted, and submitted as a separate PR.
  • The commit messages follow our commit message guidelines
  • The PR follows our contribution guidelines
  • Code changes follow our coding conventions
  • This change is covered with tests (or tests aren't necessary for this change)
  • Any relevant User Help/Developer documentation is updated; for impactful changes, information is added to the changelog for the intended release
  • CI is green

@GuySartorelli GuySartorelli mentioned this pull request Feb 15, 2024
8 tasks
Copy link
Member Author

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.

Copy link
Member Author

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.

@GuySartorelli GuySartorelli force-pushed the pulls/4/docs branch 3 times, most recently from 93fa304 to 280de69 Compare February 15, 2024 04:43
docs/en/01_basic_usage.md Show resolved Hide resolved
Comment on lines 19 to 25
<% if $HasManyLinks %>
<ul>
<% loop $HasManyLinks %>
<li>$Me</li>
<% end_loop %>
</ul>
<% end_if %>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<% 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 %>

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Comment on lines 39 to 45
<ul>
<% loop $HasManyLinks %>
<li>
<a href="$URL" <% if $OpenInNew %>target="_blank" rel="noopener noreferrer"<% end_if %>>$Title</a>
</li>
<% end_loop %>
</ul>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<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>

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@emteknetnz emteknetnz merged commit a79f97d into silverstripe:4 Feb 18, 2024
12 checks passed
@emteknetnz emteknetnz deleted the pulls/4/docs branch February 18, 2024 20:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants