Skip to content

Add first version of flutter.io/docs#817

Merged
filiph merged 5 commits intoflutter:masterfrom
filiph:new-docs-page
Feb 27, 2018
Merged

Add first version of flutter.io/docs#817
filiph merged 5 commits intoflutter:masterfrom
filiph:new-docs-page

Conversation

@filiph
Copy link
Copy Markdown
Contributor

@filiph filiph commented Feb 24, 2018

This will be the “index” of our docs (as the homepage will lack sidenav pretty soon).

This will be the “index” of our docs (as the homepage will lack sidenav pretty soon).
@filiph filiph requested a review from Sfshaza February 24, 2018 18:52
@googlebot googlebot added the cla: yes Contributor has signed the Contributor License Agreement label Feb 24, 2018
@Sfshaza
Copy link
Copy Markdown
Contributor

Sfshaza commented Feb 25, 2018

This seems great! ...But, can I see it staged?

@InMatrix
Copy link
Copy Markdown
Contributor

One downside is that it will now require 2 clicks instead of 1 to get to API docs from any page on flutter.io, since it's no long part of the top navigation. We should track how this change affects API doc usage.

Comment thread docs.md
 


## Want to skill up?
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

will this be easy to understand for non-native speakers?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I think so.

@Sfshaza, what are our options to rephrase?

Comment thread docs.md
* [Flutter Widget Inspector](/inspector/)
The Flutter Inspector, a tool available in the Flutter plugin for your IDE.

 
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

is this intention?

Copy link
Copy Markdown
Contributor Author

@filiph filiph Feb 26, 2018

Choose a reason for hiding this comment

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

Yes. This is because there is not enough space between ul and headers.

The implementation is ugly but the special-case CSS would be even uglier. When I have time, I'll see if changing the CSS everywhere to give more margin between ul and h2 won't break some page somewhere.

@filiph filiph changed the title Add first version of flutter.io/docs [DO NOT MERGE YET] Add first version of flutter.io/docs Feb 26, 2018
@filiph
Copy link
Copy Markdown
Contributor Author

filiph commented Feb 26, 2018

Alright, I fixed the example link, and confirmed we're not breaking any other links. I think I'll merge.

The URLs worked, but:

* /setup is redirected to /get-started/install/, so let’s use the final destination itself
* let’s use URLs with trailing slash, as that seems to be the canonical way on flutter.io
@filiph filiph merged commit 578fe6e into flutter:master Feb 27, 2018
@filiph filiph deleted the new-docs-page branch February 27, 2018 03:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla: yes Contributor has signed the Contributor License Agreement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants