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

Fix code sample indentation in arbre documentation #2083

Merged
merged 3 commits into from
Apr 10, 2013
Merged

Fix code sample indentation in arbre documentation #2083

merged 3 commits into from
Apr 10, 2013

Conversation

amiel
Copy link
Contributor

@amiel amiel commented Apr 9, 2013

The tab-style indentation in docs/12-arbre-components.md makes for not-so-pretty code samples.

This pull-request changes tabs in to 2 spaces. Except for the first tab, which needs to be 4 spaces for code samples.

@seanlinsley
Copy link
Contributor

What. Just what. I don't know how to respond to this.

aa_docs_splode

This is on the main activeadmin.info website, right now.

@seanlinsley
Copy link
Contributor

@gregbell, this happened when you merged #1745

@amiel
Copy link
Contributor Author

amiel commented Apr 10, 2013

Yeah, I just noticed the new documentation. Which I really appreciate. I've learned a lot of ActiveAdmin tricks by reading through the internals and other examples, but this documentation is nice to have.

I also just realized that although I fixed the indentation of code samples, I didn't do anything to the headers, which also look like they might need some adjusting...

@seanlinsley
Copy link
Contributor

Yes, that file is absolutely terrible. If you could fix it up some more, I'd really appreciate it :)

@amiel
Copy link
Contributor Author

amiel commented Apr 10, 2013

@daxter Actually, the hierarchy is pretty sane. I'm not really sure what to do with the headings...

@amiel
Copy link
Contributor Author

amiel commented Apr 10, 2013

@amiel
Copy link
Contributor Author

amiel commented Apr 10, 2013

@daxter That should do it ^^^^^

@amiel
Copy link
Contributor Author

amiel commented Apr 10, 2013

ug, I keep on forgetting to [ci skip]

@seanlinsley
Copy link
Contributor

Right now the heading hierarchy is:

# Arbre Components
## Text Node
## Common Components
### Panel Component
### Columns Component
#### Simple Columns
#### Multiple Span Columns
#### Max and Mix Column Sizes
### Table For Component
### Status tag

I would:

  • remove every use of the word "component" except the very first one
  • remove the "Common Components" header entirely, and move every sub-heading up one level in importance (so ### becomes ##)
  • rename "Max and Mix Column Sizes" to "Custom Column Widths"

@amiel
Copy link
Contributor Author

amiel commented Apr 10, 2013

@daxter Updated per your suggestions

@seanlinsley
Copy link
Contributor

Cool. This makes a huge difference to readability. Thank ya!

seanlinsley added a commit that referenced this pull request Apr 10, 2013
@seanlinsley seanlinsley merged commit 10ea58f into activeadmin:master Apr 10, 2013
@amiel amiel deleted the indentation branch April 10, 2013 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants