search

TYPO3-Documentation / t3SphinxThemeRtd

Please report only issues that concern the rendering of the official TYPO3 docs here. For help and support on TYPO3, please see: https://typo3.org/help/
MIT License
11 stars 7 forks source link

Add link to docs workflow introduction below edit button #125

Closed pixeldesu closed 4 years ago

pixeldesu commented 5 years ago

This PR adds a small section of text "Learn more about contributing" including a link to the official guide here: https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingDocsOfficial/Index.html

Here's a screenshot on how everything looks currently with all proposed CSS and HTML changes (It looks better with a wider button with more text, like in #124):

Screenshot 2019-08-05 at 23 38 34

This PR doesn't include the compiled assets required for changes to be reflected and someone who is able to run the asset generation needs to do that, regardless of what Node or Ruby version I was running I always ran into following error:

Syntax error: Invalid CSS after "      webkit-image": expected ")", was ": -webkit- + $p..."
        on line 21 of /Users/pixeldesu/Projects/t3SphinxThemeRtd/node_modules/bourbon/dist/helpers/_linear-angle-parser.scss
        from line 10 of /Users/pixeldesu/Projects/t3SphinxThemeRtd/node_modules/bourbon/dist/_bourbon.scss
        from line 11 of sass/badge_only.sass
  Use --trace for backtrace.
Syntax error: Invalid CSS after "      webkit-image": expected ")", was ": -webkit- + $p..."
        on line 21 of /Users/pixeldesu/Projects/t3SphinxThemeRtd/node_modules/bourbon/dist/helpers/_linear-angle-parser.scss
        from line 10 of /Users/pixeldesu/Projects/t3SphinxThemeRtd/node_modules/bourbon/dist/_bourbon.scss
        from line 21 of sass/theme.sass
  Use --trace for backtrace.
Syntax error: Invalid CSS after "      webkit-image": expected ")", was ": -webkit- + $p..."
        on line 21 of /Users/pixeldesu/Projects/t3SphinxThemeRtd/node_modules/bourbon/dist/helpers/_linear-angle-parser.scss
        from line 10 of /Users/pixeldesu/Projects/t3SphinxThemeRtd/node_modules/bourbon/dist/_bourbon.scss
        from line 21 of sass/theme-no-fonts.sass
  Use --trace for backtrace.

This solves #120!

marble commented 5 years ago

I'm aware of this PR. I've also seen that the RTD theme now has built in: "Edit on Github" (without "me"), and "Edit on GitLab", and "Edit on BitBucket". That logic and variables however need a bit more of work to integrate into the theme. I'll consider this PR again in that context. At the moment however, I just drop the "me" to be in line with the RTD theme.

marble commented 4 years ago

This PR has become obsolete now that https://github.com/TYPO3-Documentation/t3SphinxThemeRtd/pull/140 is merged.