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

Migrate reference docs #205

Closed
nex3 opened this issue Mar 11, 2018 · 4 comments
Closed

Migrate reference docs #205

nex3 opened this issue Mar 11, 2018 · 4 comments

Comments

@nex3
Copy link
Contributor

nex3 commented Mar 11, 2018

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.

@nex3 nex3 added this to To do in Deprecate Ruby Sass via automation Mar 11, 2018
@nex3
Copy link
Contributor Author

nex3 commented Mar 13, 2018

We should also be careful to ensure that widely-used existing URLs continue to work. In particular:

  • /documentation/file.SASS_REFERENCE.html should 301 redirect to the root of the new documentation. That documentation should have a bit of JavaScript that looks for a URL fragment and, if one is found that matches a fragment in the old reference, does a client-side redirect to a more specific location.

  • /documentation/Sass/Script/Functions.html should 301 redirect to the new function documentation, doing a similar fragment trick as above to go to a specific page if possible.

  • /documentation/file.SASS_CHANGELOG.html should 301 redirect to a language changelog (which should probably be pulled from sass/language as per Update repository structure for a post-Ruby-Sass world sass#2480).

  • /documentation/file.INDENTED_SYNTAX.html and /documentation/file.SCSS_FOR_SASS_USERS.html should both 301 redirect to a new page that explains the difference between the indented and SCSS syntaxes.

  • All other /documentation/* URLs should redirect to http://www.rubydoc.info/gems/sass/*.

@nex3
Copy link
Contributor Author

nex3 commented Aug 16, 2018

@jina I think there's enough material now on the wip.reference branch for you to take a look at fixing up the design. A few things to note:

  • I'm envisioning the table of contents (which is currently a static part of the layout) as a kind of visually-delineated sidebar thing on the left.
  • The page title takes up a lot of vertical space... it might be a good idea to make it less obtrusive.
  • I've added HTML for a compatibility table that I intend to re-use (it's currently only used in the documentation/syntax/parsing). That needs some sort of nice neat styling, probably with color-coding for supported versus unsupported.
  • I've also added HTML for an implementation-note aside, which probably wants some sort of relatively subtle styling.

I leave the details and the final decision-making in your capable hands, though!

nex3 added a commit that referenced this issue Aug 29, 2018
nex3 added a commit that referenced this issue Aug 30, 2018
@nex3 nex3 added this to In progress in Onsite Sass Reference Sep 27, 2018
jina pushed a commit that referenced this issue Oct 22, 2018
* 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
@tomByrer
Copy link
Contributor

tomByrer commented Mar 5, 2019

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.

@jina
Copy link
Member

jina commented Mar 5, 2019

we have an open ticket being looked at for doing a sticky nav: #268

@nex3 nex3 moved this from To do to In progress in Deprecate Ruby Sass Apr 4, 2019
@nex3 nex3 closed this as completed Jul 1, 2019
Deprecate Ruby Sass automation moved this from In progress to Done Jul 1, 2019
Onsite Sass Reference automation moved this from In progress to Done Jul 1, 2019
asaf400 pushed a commit to asaf400/ass-site that referenced this issue Apr 18, 2024
asaf400 pushed a commit to asaf400/ass-site that referenced this issue Apr 18, 2024
* 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
asaf400 pushed a commit to asaf400/ass-site that referenced this issue Apr 18, 2024
asaf400 pushed a commit to asaf400/ass-site that referenced this issue Apr 18, 2024
* 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
Friendly-users added a commit to Friendly-users/sass-site that referenced this issue Jun 27, 2024
-----
It is inappropriate to include political and offensive content in public code repositories.

Public code repositories should be neutral spaces for collaboration and community, free from personal or political views that could alienate or discriminate against others. Political content, especially that which targets or disparages minority groups, can be harmful and divisive. It can make people feel unwelcome and unsafe, and it can create a hostile work environment.

Please refrain from adding such content to public code repositories.
---

 sass#200 sass#201 sass#202 sass#203 sass#204 sass#205 sass#206 sass#207 sass#208 sass#209 sass#210 sass#211 sass#212 sass#213 sass#214 sass#215 sass#216 sass#217 sass#218 sass#219 sass#220 sass#221 sass#222 sass#223 sass#224 sass#225 sass#226 sass#227 sass#228 sass#229 sass#230 sass#231 sass#232 sass#233 sass#234 sass#235 sass#236 sass#237 sass#238 sass#239 sass#240 sass#241 sass#242 sass#243 sass#244 sass#245 sass#246 sass#247 sass#248 sass#249 sass#250 sass#251 sass#252 sass#253 sass#254 sass#255 sass#256 sass#257 sass#258 sass#259 sass#260 sass#261 sass#262 sass#263 sass#264 sass#265 sass#266 sass#267 sass#268 sass#269 sass#270 sass#271 sass#272 sass#273 sass#274 sass#275 sass#276 sass#277 sass#278 sass#279 sass#280 sass#281 sass#282 sass#283 sass#284 sass#285 sass#286 sass#287 sass#288 sass#289 sass#290 sass#291 sass#292 sass#293 sass#294 sass#295 sass#296 sass#297 sass#298 sass#298 sass#299
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

3 participants