Skip to content
This repository was archived by the owner on Sep 5, 2024. It is now read-only.

docs: clarify that this project aligns with the MD spec from 2014-2017 #11463

Merged
merged 1 commit into from
Sep 27, 2018
Merged

docs: clarify that this project aligns with the MD spec from 2014-2017 #11463

merged 1 commit into from
Sep 27, 2018

Conversation

Splaktar
Copy link
Contributor

PR Checklist

Please check that your PR fulfills the following requirements:

  • The commit message follows our guidelines
  • Tests for the changes have been added or this is not a bug fix / enhancement
  • Docs have been added, updated, or were not required

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Enhancement
[x] Documentation content changes
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Infrastructure changes
[ ] Other... Please describe:

What is the current behavior?

Developers looking for the latest features from the MD spec may be confused when reading our docs.

Issue Number:
Relates to #11415. Relates to #11420.

What is the new behavior?

  • clarify that this project aligns with the MD spec from 2014-2017
  • clearly reference that the Angular Material project is that place
    to find an implementation of the new MD spec
  • fix extra space in version string
  • add Gitter and NPM badges to readme

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

@googlebot googlebot added the cla: yes PR author has signed Google's CLA: https://opensource.google.com/docs/cla/ label Sep 27, 2018
@Splaktar Splaktar force-pushed the docsReadmeUpdatesforNewMD branch from 22a7895 to e0d0eea Compare September 27, 2018 00:31
@Splaktar
docs: clarify that this project aligns with the MD spec from 2014-2017
4f40d4b 
clearly reference that the Angular Material project is that place
- to find an implementation of the new MD spec
fix extra space in version string
add Gitter and NPM badges to readme

Relates to #11415. Relates to #11420.
@Splaktar Splaktar force-pushed the docsReadmeUpdatesforNewMD branch from e0d0eea to 4f40d4b Compare September 27, 2018 00:33
@Splaktar Splaktar added this to the 1.1.11 milestone Sep 27, 2018
@Splaktar Splaktar added type: docs pr: merge ready This PR is ready for a caretaker to review pr: merge safe P3: important Important issues that really should be fixed when possible. labels Sep 27, 2018
jelbourn
jelbourn approved these changes Sep 27, 2018
View reviewed changes
Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

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

LGTM

@jelbourn jelbourn merged commit 0671aab into master Sep 27, 2018
@Splaktar Splaktar deleted the docsReadmeUpdatesforNewMD branch September 27, 2018 00:55
marosoft pushed a commit to marosoft/material that referenced this pull request Nov 11, 2018
@Splaktar @marosoft
docs: clarify that this project aligns with the MD spec from 2014-2017 (
2ff6c82 
angular#11463)

clearly reference that the Angular Material project is that place
- to find an implementation of the new MD spec
fix extra space in version string
add Gitter and NPM badges to readme

Relates to angular#11415. Relates to angular#11420.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
1 more reviewer

@jelbourn jelbourn jelbourn approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees

@jelbourn jelbourn

Labels
cla: yes PR author has signed Google's CLA: https://opensource.google.com/docs/cla/ P3: important Important issues that really should be fixed when possible. pr: merge ready This PR is ready for a caretaker to review type: docs
Projects
None yet
Milestone
1.1.11
Development

Successfully merging this pull request may close these issues.
3 participants
@Splaktar @jelbourn @googlebot