factor-tutorial icon indicating copy to clipboard operation
factor-tutorial copied to clipboard

Out-of-date function names

Open pierre-rouleau opened this issue 1 year ago • 9 comments

Hi @andreaferretti

Thanks for writing this! This document is a nice introduction to Factor!

However, the name of some words have been modified in the latest version of Factor (at last as it is today in Github).
For instance, [a,b] is now [a..b].

I'll be learning Factor and will probably use it later to build some tools. If it makes sense to update the docs at this point, let me know and I would probably contribute updates while I have time to do it.

pierre-rouleau avatar Jan 09 '24 22:01 pierre-rouleau

We have integrated this with the main repository now and it is kept up-to-date:

https://docs.factorcode.org/content/article-tour.html

You can also access it from a Factor instance:

IN: scratchpad "tour" help

mrjbq7 avatar Jan 09 '24 23:01 mrjbq7

If you have suggestions or additions, we would be happy to hear them -- you can make issues on github or report on our discord.

mrjbq7 avatar Jan 09 '24 23:01 mrjbq7

I noticed that Factor's help contained this and Factor's help was up-to-date which is great!

Perhaps a mention in the readme of this Github project should mention it. And maybe this current project should be closed or made read-only because the factor project content holds the text first created here?

pierre-rouleau avatar Jan 10 '24 03:01 pierre-rouleau

@pierre-rouleau I just updated the tutorial to mention that is now included in the official documentation. If everything still works, it will show up in the site soon

andreaferretti avatar Jan 11 '24 14:01 andreaferretti

Thanks,@andreaferretti, unfortunately your Github-Pages driven site did not refresh.

pierre-rouleau avatar Jan 12 '24 15:01 pierre-rouleau

¯_(ツ)_/¯ Unfortunately, I don't remember how I set up the site, so I don't know how to refresh it

andreaferretti avatar Jan 12 '24 16:01 andreaferretti

No problem. I should learn how to use Pages myself too :-)

pierre-rouleau avatar Jan 12 '24 16:01 pierre-rouleau

it looks like it's from the gh-pages branch (https://github.com/andreaferretti/factor-tutorial/tree/gh-pages) and probably configured/deployed on the settings page (https://github.com/andreaferretti/factor-tutorial/settings/pages)

mrjbq7 avatar Jan 12 '24 16:01 mrjbq7

I am pretty sure there was a way in the settings to tell Github that the gh-pages branch should be built automatically using Jekyll and the markdown in the README of the master branch. I did not maintain a separate branch myself, I just committed to the README and then some kind of hook would run Jekyll and publish the site.

I think that in all these years this mechanism has disapperated in favour of some more general hook mechanism or something, and now I don't have the time to reconstruct how to build the site myself just to add this disclaimer, sorry

andreaferretti avatar Jan 18 '24 10:01 andreaferretti