23 Commits

Author SHA1 Message Date
Andrew Overton
8d8763ef71 [Multiple components] Audit recent docs changes, part 1
Closes https://github.com/material-components/material-components-ios/pull/10132

PiperOrigin-RevId: 345256835
2020-12-02 10:10:55 -08:00
Andrew Overton
b205164477 Delete obsolete markdown files
As I've gone through and replaced all the READMEs I haven't always been good at deleting the markdown files that were stitched together to make the old READMEs. This PR removes all the ones I forgot to remove. All the relevant material in these files is already in the new READMEs, so we're not losing anything by doing this.

Closes https://github.com/material-components/material-components-ios/pull/10029

COPYBARA_INTEGRATE_REVIEW=https://github.com/material-components/material-components-ios/pull/10029 from andrewoverton:delete-unused-docs 65ea55253af300ea7a4c13ea4ce14976097a6253
PiperOrigin-RevId: 318079032
2020-06-24 09:31:01 -07:00
Andrew Overton
54723a16a4 [Cards] Replace Cards documentation
This PR replaces the Cards documentation with different Cards documentation. To preview the docs, see [here](https://github.com/andrewoverton/material-components-ios/tree/cards-docs/components/Cards).

Closes https://github.com/material-components/material-components-ios/pull/9965

COPYBARA_INTEGRATE_REVIEW=https://github.com/material-components/material-components-ios/pull/9965 from andrewoverton:cards-docs 140637c2f4f7c24ba25099352c5f9c066d84035b
PiperOrigin-RevId: 306670257
2020-04-15 10:34:23 -07:00
Bryan Oltman
900ace5c7b
[Cards] Properly use headings for 'Swift' and 'Objective C' above sample code (#9353)
Updates code sample headings for consistency with other documentation.
2019-12-30 12:24:21 -05:00
Bryan Oltman
08a2b20d70
[Cards] Remove references to Themer from README (#9261)
Card Themer classes were deleted, and our documentation should be updated to reflect that.

Fixes #9197
2019-12-13 10:28:51 -05:00
Andrew Overton
1a067127a2
Delete old docs (#9163)
Tangentially related #9066
2019-12-06 15:40:32 -05:00
Robert Moore
c5188966f6
[Cards, Chips, Tabs] Fix theming docs. (#8431)
Formatting errors in the Theming Extension sections resulted in Markdown
rendering errors.

Part of #7162
Follow-up to #7193
Follow-up to #7194
2019-09-10 10:09:37 -04:00
Wenyu Zhang
a6815d2218
[Cards] add missing theming extension doc. (#7193)
Updated unused theming.md to reflect theming extension documentation.
2019-04-22 15:10:42 -04:00
Robert Moore
372d6b24f9
No longer using -init for Color Scheme. (#5734)
{MDC iOS} No longer using `-init` for Color Scheme.

Based on the discussions in go/mdc-ios-theming, we should not use the `-init` default initializer. Instead, we should use an explicit set of defaults.

Search regex: '\[\[MDCSemanticColorScheme alloc\] init\]'
2018-11-12 12:54:47 -05:00
Robert Moore
74a27253e8
Global replace of integral single-precision literals with integer literals. (#5709)
Global replace of integral single-precision literals with integer literals.

Regular expression used:
```perl
/[^\w]([0-9]+)\.[0]*[fF]/$1/
```
2018-11-08 14:02:04 -05:00
Yarden Eitan
d7f566994a
[Docs] Adds the shape themer API to the supporting components using the doc generation (#5464)
This PR adds the shape theming API documentation using the doc generation script improvements that were added in PR #5463 .

To achieve this, I added into the .vars files of the supported components the missing variables, and ran the script `scripts/apply_all_templates`. Then I ran `scripts/generate_readme component` for the components that have been added the `shape-theming.md` file, so it is seen in the actual README.md of the component.

Specifically, Bottom Sheet was using the old method of documentation, and wasn't using the right generation method, so it's doc content was just copied to the right location to allow its generation to work well as well.

Closes #5319
2018-10-19 17:05:50 -04:00
Galia Kaufman
cf014946d8
[Cards] Accessibility: Fixing documentation typos (#4634)
* Fixing typos in accessibility documentation for Cards.
* Fixing a script to correctly show a message when Jazzy is not installed.
2018-07-30 13:35:34 -04:00
Galia Kaufman
ae8231e49a
[Cards] Add accessibility documentation (#4454)
Adding accessibility documentation to Cards.
Closes issue: b/78768477.
2018-07-16 10:27:08 -04:00
featherless
e1e6d249a4
[Docs] Add badges to all components. (#4278)
As part of our readme generator, components can now opt in to displaying badges in their readme.

The badges are generated from https://shields.io/ and are focused on an individual component. We're currently generating the following badges:

- Open bug count.
2018-05-25 11:12:48 -04:00
Jeff Verkoeyen
790062b34f [Cards] Fix the cards docs image asset. 2018-05-24 12:23:09 -04:00
Jeff Verkoeyen
d94e03161a [Cards] Update image and docs. 2018-05-03 17:19:28 -04:00
featherless
da21941afa
Regenerate component docs with automatic API links. (#3673)
Example output:

<img width="468" alt="screen shot 2018-05-02 at 10 33 23 pm" src="https://user-images.githubusercontent.com/45670/39557914-d9512f38-4e58-11e8-824d-60f03bcd1b76.png">
2018-05-02 22:33:55 -04:00
Adrian Secord
14b9c1503f
Global replace of "utilize" vs "use". (#3662) 2018-05-02 16:51:59 -04:00
featherless
037bf7d0f0
Flatten all +Extensions CocoaPods targets into standalone targets. (#3572)
This discourages depending on all of a component's extensions and aligns our targets more closely with how we expect them to be imported and depended upon.

This is a breaking change.

Pivotal story: https://www.pivotaltracker.com/story/show/157118721
2018-05-02 10:20:01 -04:00
featherless
a3ad2dde8a
[Cards] Split the documentation into separate articles and run the readme generator. (#3618) 2018-05-01 16:44:50 -04:00
Adrian Secord
7a7293883f
Remove space after triple-backtick Markdown syntax. (#3577) 2018-04-29 09:00:53 -04:00
featherless
d3c5316db0 Generate all themer documentation. (#3562)
* Generate all themer documentation.

* Fix Snackbar vars.

* Fix textfields vars.

* Fix link.

* Fix bottom app bar vars.

* Fix more vars.

* Add home page links.

* Fix typos.

* Fix more links.

* Add ink.

* Tabs.

* Cleanup.
2018-04-27 16:59:03 -04:00
Yarden Eitan
58f24b4f18 [Cards] Initial Implementation (#2894)
* [Cards] New API Header files (#2886)

* header files

* rename to MDCCardCollectionCell

* update for review

* update to review

* update to review

* [Cards] Full Implementation (#2892)

* cards core implementation

* updates to API and fixes from doc

* small fixes

* podspec, examples, and tests

* small fixes

* small fix

* small fix

* update inkView API and some small nits

* refactor API and code

* refactor API and code

* remove private header

* rename to MDCCardCollectionCell

* updates to api review

* update based on reviews

* fix tests

* [Cards] Initial Docs

* updates to encoding

* small fix

* pr update

* pr update

* pr update

* pr update

* pr update

* pr update

* pr update

* ink api update

* ink api update
2018-02-01 18:45:43 -05:00