search

fuse-open / docs

Fuse documentation
https://fuseopen.com/docs
Other
12 stars 16 forks source link

A new hope #15

Closed AndrewEQ closed 5 years ago

AndrewEQ commented 5 years ago

Callout usage: "> [callout_warn] My sentence" "> [callout_success] My sentence" "> [callout_danger] My sentence" "> [callout_info] My sentence" "> [callout_light] My sentence" "> [callout_dark] My sentence"

kusma commented 5 years ago

@AndrewEQ: Could you separate out the different bulleted items into separate commits?

AndrewEQ commented 5 years ago

Your wish is my command 😄 ...

kusma commented 5 years ago

Hmm... I'm trying to figure out how to preview the end-result...

AndrewEQ commented 5 years ago

Was wondering how the original guys tested it, please let me know if you figure it out; I had to use the web inspector and online environments for the component.

You could try it out and revert when done or branch a test version?

kusma commented 5 years ago

I think I used to have a Docker image that built this or something... it was done in a hurry to make things public before I left the company, so not everything was done perfectly, sadly.

kusma commented 5 years ago

Ideally I wanted to migrate the docs to something like readthedocs, but I never found the time for that... In particular, I had no idea how to deal with the API reference docs in that case.

AndrewEQ commented 5 years ago

Yeah, that would be cool, hmm: https://docs.readthedocs.io/en/latest/intro/import-guide.html

AndrewEQ commented 5 years ago

We'd have to prototype it sometime

AndrewEQ commented 5 years ago

So what's our current process for the docs or API references to be generated?

AndrewEQ commented 5 years ago

This one also looks nice: https://docsify.js.org

LuisRodriguezLD commented 5 years ago

I personally like docusaurus.io. Just my two cents.

AndrewEQ commented 5 years ago

Hmm, yeah, actually its also pretty clean and has the extra sub-menu on the right.

kusma commented 5 years ago

OK, so I managed to test this out, and sadly there's a few problems.

  1. The scroll-bars for the menu is misplaced, and sticks a bit into the menu-area.
  2. The small-size version are, uh, not at all working. The menu starts overlapping the text pretty quickly, and at the smallest breakpoints they're completely overlapping.
  3. Syntax highlighting seems to be broken.
  4. I get these warnings / errors in Firefox:
    • jQuery.Deferred exception: $(...).html(...) is undefined @file:///C:/Users/kusma/source/repos/fuse-open/docs/_site/site.js:35:96 l@file:///C:/Users/kusma/source/repos/fuse-open/docs/_site/jquery.js:2:29373 a/</c<@file:///C:/Users/kusma/source/repos/fuse-open/docs/_site/jquery.js:2:29677 undefined at jquery.js:2:30920
    • TypeError: $(...).html(...) is undefined at site.js:35:96
  5. I get these warnings / errors in Chrome:
    • jQuery.Deferred exception: Cannot read property 'replace' of undefined TypeError: Cannot read property 'replace' of undefined at HTMLDocument.<anonymous> (file:///C:/Users/kusma/source/repos/fuse-open/docs/_site/site.js:35:102) at l (file:///C:/Users/kusma/source/repos/fuse-open/docs/_site/jquery.js:2:29375) at c (file:///C:/Users/kusma/source/repos/fuse-open/docs/_site/jquery.js:2:29677) undefined at jquery.js:2
    • Uncaught TypeError: Cannot read property 'replace' of undefined at HTMLDocument.<anonymous> (site.js:35) at l (jquery.js:2) at c (jquery.js:2) at jquery.js:2

That being said, I really like the callout-coloring etc. But are they supposed to contain the "[callout-info]" tags in the text? I know they already do, but perhaps we could remove it now?

AndrewEQ commented 5 years ago

I shall work on the menu a bit more in the meantime

kusma commented 5 years ago

I think we landed all of the important changes from this one, no? If not, please rebase and reopen :)