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

[skip changelog] Add headings to delineate the platform referencing documentation #874

Merged
merged 1 commit into from
Jul 28, 2020
Merged

[skip changelog] Add headings to delineate the platform referencing documentation #874

merged 1 commit into from
Jul 28, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jul 27, 2020

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests
    before creating one)
  • The PR follows our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce?
  • What is the current behavior?

The platform referencing documentation content in the Arduino platform specification falls into four categories:

  • general
  • core
  • variant
  • tool

but it's not obvious where the content for each category began and ended.

  • What is the new behavior?

The referencing documentation content is clearly separated into its areas of applicability.

  • Does this PR introduce a breaking change?

No.

The platform referencing documentation content falls into four categories:

- general
- core
- variant
- tool

Previously, it was not obvious where the content for each category began and ended.
@per1234 per1234 added the topic: documentation Related to documentation for the project label Jul 27, 2020
@per1234 per1234 merged commit 678a48b into arduino:master Jul 28, 2020
@per1234 per1234 deleted the referencing-sections branch July 28, 2020 09:45
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants