montferret/montferret.github.io

Website for Ferret project

Ferret Website

Built with Hugo

Prerequisites

• Go
• Hugo
• Node.js
• Mage for building the website.
• frep(optional) is the tool used for templating the documentation

Getting Started

Installing dependencies

go mod tidy && mage install

Dev server

mage serve

Generating API docs

Generating stdlib documentation requires doc rep YAML.

mage generate

Publishing

mage publish

montferret.github.io's Issues

generate-docs.sh should support versioning

Such as,

• docs/stdlib/collections/
• docs/stdlib/collections/v0.x.y/

RSS or do I have to write a scraper in ferret to subscribe to the blog?

I mean that's cool, but maybe you could add an rss feed, so people can subscribe.

Ferret is absolutely awesome, thanks for making it open source in any case.

Init readme.md

Hi @ziflex, need you to create a readme.md or any single file here so the repo is clonable. Thanks!

Update design in SDK docs

Let's add a list of functions when you are inside a particular namespace.
For example, when I'm in array, I want to quickly jump to a particular function by clicking on the right side menu with available functions in this namespace.
Now I have to scroll to it.

Interactive shell / query editor

Once we migrate to Gatsby, I want to add “Try it” page with an editor where people can write and execute queries in order to get a flavor of our tool.

The execution part will be handled by a Ferret worker that I deployed to Google cloud, a url will be provided later.

Sort function names in stdlib

Sort function names in stdlib

Add new "Tools" section

The project has grown since the beginning and we have developed many tools around Ferret.
Let's tell people about them by adding dropdown 'Tools' to the header which will show:

• lab Scripts test runner
• worker Containerized Ferret
• ferrer-wasm Experimental package that contains Ferret compiled into WASM binary that allows you to run Ferret in a browser.

There is besynes project, Ferret IDE, but it's still in very early stage, so no need to add it.

Cookbook page

We need to have a “Cookbook” page with common recipes like pagination, downloading an image, taking a screenshot and etc.

Ideally they should be interactive that people could immediately play with it.

Migrate to Gatsby

Hugo is a nice tool but it’s pretty inconvenient to build interactive webpages.
Plus, it’s API is kinda difficult to remember if you don’t use it too often which slows down the progress.

I have worked with Gatsby little bit before and I got very good impression of the tool. And what’s more important - it’s very extensible, something that Hugo lacks.

One of the biggest reasons why I want to move to Gatsby is an interactive shell for demo queries that I want to introduce. I’m not saying it’s impossible to do with Hugo, I’m just saying it will be much easier and naturally to do in Gatsby (your webpage is a React application after all).