Skip to content
This repository has been archived by the owner on Aug 19, 2021. It is now read-only.

Integrate awesome-fable to fable website? #91

Open
MangelMaxime opened this issue Jun 20, 2021 · 5 comments
Open

Integrate awesome-fable to fable website? #91

MangelMaxime opened this issue Jun 20, 2021 · 5 comments

Comments

@MangelMaxime
Copy link
Collaborator

MangelMaxime commented Jun 20, 2021

Hello @kunjee17,

I am currently working on a re-organisation / rewrite of Fable website and I would like to add a Community section to it.

I think the Awesome Fable list could have it's place and it will help better integrate it and centralized everything (making it easier to discover for new users / contributor).

Here is a rough showcase of the result:

image

User click on the link n°1 and then n°2 to access this page.

The TOC (light blue section on the left), is always visible even when the user scrolls.

I didn't discuss it with the others maintainers yet as I wanted to discuss it first with you.

What do you think?

Edit: If you don't feel like it is a good idea, I will always be able to just force a redirect to the awesome-fable repository when clicking on the link.

It is already done like that today when you click on "Awesome Fable" (at the bottom of the menu) on this website: https://fable.io/docs/

I just tough it could be nice to have it integrated a bit more.

@kunjee17
Copy link
Owner

@MangelMaxime You might not believe but I propose this long back to @alfonsogarciacaro . But at that time we are just getting started with things so we haven't integrated it. I am all for it. Thanks for putting an effort to make long pending wish a reality.

@alfonsogarciacaro
Copy link
Collaborator

I forgot completely about that 😅 In any case, I would be very happy to have awesome-fable integrated with the main site to avoid fragmentation. Although in that case, I would remove the Community page because it would be two sections very similar that can be a source of confusion and a chore to maintain (funny is right before seeing this notification I had spent a couple of hours updating community.json).

A couple of remarks:

  • We should stop trying asking authors update the list by themselves. We've tried many times and it only works in a few cases. Probably the easiest thing is that someone goes from time to time to Fable Twitter feed and checks what announcements haven't been included in the Awesome/Community list. We could add the date of the last update so we remember to do it when, say, 2 or 3 months have passed :)
  • I like very much the design from @MangelMaxime, although I'm still fond of the dynamic filter feature. My ideal would be to have random cards as in fsprojects but nicer using maybe Bulma tiles and random sizes. But I'm also fine with the proposed design if you prefer it or it's easier to integrate. The TOC has advantages too.

@MangelMaxime
Copy link
Collaborator Author

@MangelMaxime You might not believe but I propose this long back to @alfonsogarciacaro . But at that time we are just getting started with things so we haven't integrated it. I am all for it. Thanks for putting an effort to make long pending wish a reality.

That's good news :)

Although in that case, I would remove the Community page because it would be two sections very similar that can be a source of confusion and a chore to maintain (funny is right before seeing this notification I had spent a couple of hours updating community.json).

The community page was more to have links to Gitter, Twitter, F# Slack, main github repositories etc.

The current community project would be put on hold for now because indeed there are duplicate information here.

The problems with tiles layout is that they are pretty noisy and you can't just fast read across them because your eyes need to go Right to Left, go down one line, Right to Left, etc.

For now, I think we should learn from our past mistakes and go for the "easy" way. We have more critical tasks to do on the documentation part IHMO.

The TOC can be 2 level deep making it easier to categorise everything:

image

This means if needed, we will be able to regroup similar library understand a category example:

  • Libraries
    • Json
    • React
    • Elmish

The tiles layout / interactive search is something I have ideas for in the future like having a dedicated "packages" page/website where you can find all the Fable packages with their documentation similar to what is done for Elm for example. Because for me the real value of this page is not really the layout but the fact that package documentation are centralized for the APIs at least.

It is still possible to have dedicated documentation website for use cases, guides, etc.

* We should stop trying asking authors update the list by themselves. We've tried many times and it only works in a few cases. Probably the easiest thing is that someone goes from time to time to Fable Twitter feed and checks what announcements haven't been included in the Awesome/Community list. We could add the date of the last update so we remember to do it when, say, 2 or 3 months have passed :)

One way to do it could also be to list check all the packages released with fable tag: https://www.nuget.org/packages?q=Tags:"fable"

When I have something ready, I will make sure to create a PR on Fable website so people can see the new version and discuss it :) etc.

@mabasic
Copy link

mabasic commented Jul 19, 2021

Brutal addition to the website.

@MangelMaxime
Copy link
Collaborator Author

@kunjee17 I finally have the new re-design of Fable website ready with Fable Awesome integrated in it. I just asked for review so hopefully it should soon be released.

fable-compiler/fable-compiler.github.io#98 (comment)

It is under the Resources.md file.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants