Skip to content

[skip changelog] Link to Sketch build process docs from Platform specification #1025

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

Merged
merged 1 commit into from
Oct 12, 2020
Merged

[skip changelog] Link to Sketch build process docs from Platform specification #1025

merged 1 commit into from
Oct 12, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Oct 11, 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?

Docs update

  • What is the current behavior?

The "Build process" section of the Arduino platform specification contains a short summary of the Arduino sketch build
process. The "Sketch build process" page of the documentation provides much more detailed information, which wouldn't be
appropriate in the platform specification, but could well be of interest to a platform developer.

  • What is the new behavior?

Adding a link to the "Sketch build process" documentation from that section of the Platform specification makes all
relevant information easily accessible to the reader.

  • Does this PR introduce a breaking change?

No

…ification

The "Build process" section of the Arduino platform specification contains a short summary of the Arduino sketch build
process. The "Sketch build process" page of the documentation provides much more detailed information, which wouldn't be
appropriate in the platform specification, but could well be of interest to a platform developer.

Adding a link to the "Sketch build process" documentation from that section of the Platform specification makes all
relevant information easily accessible to the reader.
@per1234 per1234 added the topic: documentation Related to documentation for the project label Oct 11, 2020
@per1234 per1234 merged commit 178a4b0 into arduino:master Oct 12, 2020
@per1234 per1234 deleted the build-process-link branch October 12, 2020 06: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