Codebase to Tutorial easy to follow tutorials from GitHub codebases with AI

This deserves its own thread
@Traktion generated docs from code2tutorial.com

Please read

and

Impressed so far but… discuss corrections, improvements, hallucinations etc.

I may be persuaded AI is OK for some grunt work :slight_smile:

Terms of Service - Codebase to Tutorial <–smarter, more cynical folk than me should probably look here.

2 Likes

The std link display is a PITA, its hard add a link when its the same every time.

Anyway
https://code2tutorial.com/tutorial/b567995c-c13d-4771-94e0-bc58441a3a1e/03_network_communication_.md

could use more graphics
EDIT press F5 if you dont get nice diagrams

The “voice” seems to change quite abruptly in places. One minute its addressing folk who barely have the concept of a TV remote and the next its calling methods. I’m sure that can get sorted.

This is excellent though

This is an excellent foundation to build proper documentation on.
Perhaps a “gentler” overview could be quickly extracted from this for near n00bs
More pics, less code and more rigorous docs with full code commentary created later .

If every IF project generated docs with this tool, it would be interesting to see how common concepts are handled.
Will we see the same boilerplate for say Scratchpads ?

1 Like

Its poetry, sheer poetry

“The Ballad o’ the DataMap”

(In the style of Robert Burns)

Verse 1: The Data’s Journey
"O’er wires an’ waves the bytes do flee,
Like wee birdies takin’ wing sae free.
The Client, wise as auld Lochlea,
Self-encrypts wi’ care:
To chunks it breaks, sae sma’ an’ tight,
While DataMaps blaze wi’ crypted light—
A ledger fair for a’ tae see,
Or hide, should ye dare."

Verse 2: The Public Way
"When data’s bared for public ken,
Yon Map’s address is ta’en again.
It joins the flock on network’s glen,
Nae mair than a chunk.
But fetch it back wi’ ‘get’ sae keen,
An’ a’ the pieces soon convene—
Like sheaves o’ corn at harvest’s end,
To wha’ holds the trunk."

Verse 3: The Private Path
"Yet hid frae licht, like gowd in stream,
The Private Map’s a treasured dream.
Ne’er cast upon the network’s scheme,
But kept close an’ dear.
Wi’ ‘data_get’ ye wield its might,
To summon chunks back intae sight—
For nane but ye wha’ own the key
May ever draw near!"

Moral (Final Stanza)
"So mark ye weel this DataMap art,
Twa paths diverge frae one smart start:
An’ mind!—the choice that sets apart
The open frae the sealed.
For public shares wi’ a’ the land,
But private stays in thy ain hand,
Like love or freedom, dearly planned,
Or seeds in Springtime’s field."

Given the raw docs are markdown files, they could also be persisted to autonomi pretty easily.

It’s actually very similar to what IMIM does with blogs - they are public archives of markdown files and assets.

Maybe a project for the future there! :smiley:

1 Like