-
Notifications
You must be signed in to change notification settings - Fork 232
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
Migrate reference docs #205
Comments
We should also be careful to ensure that widely-used existing URLs continue to work. In particular:
|
@jina I think there's enough material now on the
I leave the details and the final decision-making in your capable hands, though! |
* Add a helper for writing inline multi-syntax examples This will be useful for #205. * Add the ability to add CSS output to the syntax switcher * Automatically generate CSS for the syntax switcher by default * Fix most lints * Fix a specificity bug * Show SCSS syntax by default * Fix a couple more lints * Make the example helper template-engine-agnostic * Support a "syntax switcher" with a single syntax This will make it possible to do nice-looking single-syntax code examples in the reference. * Remove trailing whitespace
I'm OK with current 1-page layout, though I wish the menu floated. But the references to Ruby-sass, eg configuration files are very confusing & I hope are changed soon. |
we have an open ticket being looked at for doing a sticky nav: #268 |
This will be useful for sass#205.
* Add a helper for writing inline multi-syntax examples This will be useful for sass#205. * Add the ability to add CSS output to the syntax switcher * Automatically generate CSS for the syntax switcher by default * Fix most lints * Fix a specificity bug * Show SCSS syntax by default * Fix a couple more lints * Make the example helper template-engine-agnostic * Support a "syntax switcher" with a single syntax This will make it possible to do nice-looking single-syntax code examples in the reference. * Remove trailing whitespace
This will be useful for sass#205.
* Add a helper for writing inline multi-syntax examples This will be useful for sass#205. * Add the ability to add CSS output to the syntax switcher * Automatically generate CSS for the syntax switcher by default * Fix most lints * Fix a specificity bug * Show SCSS syntax by default * Fix a couple more lints * Make the example helper template-engine-agnostic * Support a "syntax switcher" with a single syntax This will make it possible to do nice-looking single-syntax code examples in the reference. * Remove trailing whitespace
The Sass reference has never been the most user-friendly documentation, and as Ruby Sass moves towards end-of-life it'll be more important not to pull the primary source of language documentation from its repository and infrastructure. I think the best thing to do would be to make the reference documentation a native part of the site, and take that opportunity to rethink how it's presented. This includes function documentation, which is currently even more tightly coupled to Ruby.
@sass/core @sass/sass-site I'm happy to take on the work of and updating the prose, but I could use some help figuring out the best way to present it. I'm thinking roughly taking each sub-section of the existing reference and making it a separate page, with some sort of table of contents making it easier to navigate. Python's language documentation is good prior art here, but I'd very much appreciate suggestions from folks who regularly consume this sort of documentation.
I'll also need some design assistance getting the reference layout looking nice and consistent with the rest of the site.
The text was updated successfully, but these errors were encountered: