The Moor Book, v0.1 #378

abesto · 2025-01-20T12:10:55Z

Tl;dr: https://abesto.github.io/moor/the-moo-programming-language/built-in-functions/manipulating-moo-values.html#function-tostr

Took the Stunt manual, formatted it into an mdBook (book/gen-from-stunt)
Did some formatting work, most notably:
- Function signatures now look not horrible
- Turned function headers into actual headers (instead of bold text), making them directly linkable (thanks mdBook)
Added MOO syntax highlighting (book/theme/moo-syntax-highlight.js)
Dropped some of the bigger sections documenting Stunt features not supported in Moor
Set up a GH Action to publish the book when changes to it are pushed to main

This should be all that's needed to allow work to start on the content for real.
N.B.: the Legal and Foreword sections need to be updated ASAP.

!!! Required repo setup !!!

For the workflow to work, the GitHub Pages settings of the repo need to be flipped from "Deploy from a branch" to "GitHub Actions" under Settings -> Pages.

References

mdBook: https://rust-lang.github.io/mdBook/
highlight.js docs 10.1.1 (very old, but this is what's used in mdBook): https://github.com/highlightjs/highlight.js/tree/10.1.1/docs
mdBook automated deployment: https://github.com/rust-lang/mdBook/wiki/Automated-Deployment%3A-GitHub-Actions
Inspiration for the horrible hack to inject the MOO language syntax highlighting rules: Custom Language Syntax Highlighting rust-lang/mdBook#657, Highlight syntax in documentation pen-lang/pen#395

The implementation is heavily dependent on highlightjs. There are noises about mdbook replacing highlightjs with something different; if/when that happens, this will need to be ported.

Removed the old ToastStunt forward. Wrote my own.

First draft here. Replace references to Toast with mooR. Tones down "virtual reality" talk a bit. Explanatory note about mooR vs LambdaMOO.

Also removes some Toast-specific entries, adds context text, and shuffles location in the SUMMARY.md

* Remove WAIFs, bools, and anonymous objects (bools may come back) * Add flyweights * Update notes about maps since mooR maps are slightly different * Update notes about maximum integers and floats.

anubi · 2025-02-10T02:03:24Z

It would be nice to also have some information about running moor in a guide like this too, server administration of it requires a little know-how :(
I was curious about this project, but it doesn't connect and I've made no modifications from master; not asking you to fix it, but basic troubleshooting tips in readme.md or a pretty "book" would be nice:

Attaching to moor-daemon, moor-telnet-host, moor-web-host
moor-telnet-host | 2025-02-10T01:59:49.504666Z INFO main rpc_async_client: crates/rpc/rpc-async-client/src/lib.rs:90: Registering host with daemon...
moor-daemon | 2025-02-10T01:59:49.923322Z INFO main moor_daemon: crates/daemon/src/main.rs:95: moor 0.9.0-alpha daemon starting. Using database at "development.db"
moor-daemon | 2025-02-10T01:59:49.924485Z INFO main moor_daemon: crates/daemon/src/main.rs:102: Opened database path="development.db"
moor-daemon | 2025-02-10T01:59:49.924505Z INFO main moor_daemon: crates/daemon/src/main.rs:107: Database already exists, skipping textdump import
moor-daemon | 2025-02-10T01:59:49.924911Z INFO main moor_daemon::rpc_server: crates/daemon/src/rpc_server.rs:106: Creating new RPC server; with 8 ZMQ IO threads...
moor-daemon | 2025-02-10T01:59:49.925645Z INFO main moor_daemon::connections_fjall: crates/daemon/src/connections_fjall.rs:72: Opening connections database at "connections.db"
moor-daemon | 2025-02-10T01:59:49.926341Z INFO main moor_daemon::rpc_server: crates/daemon/src/rpc_server.rs:119: Created connections list, with 1 initial known connections
moor-daemon | 2025-02-10T01:59:49.928566Z INFO main moor_daemon: crates/daemon/src/main.rs:188: Checkpointing enabled to textdump-out. Interval: 360s
moor-daemon | 2025-02-10T01:59:49.928664Z INFO moor-scheduler run: moor_kernel::tasks::suspension: crates/kernel/src/tasks/suspension.rs:111: Loaded suspended tasks from tasks database num_tasks=0
moor-daemon | 2025-02-10T01:59:49.928687Z INFO moor-scheduler run: moor_kernel::tasks::scheduler: crates/kernel/src/tasks/scheduler.rs:199: Starting scheduler loop
moor-daemon | 2025-02-10T01:59:49.928701Z INFO main moor_daemon: crates/daemon/src/main.rs:221: Daemon started. Listening for RPC events. rpc_endpoint="tcp://0.0.0.0:7899" events_endpoint="tcp://0.0.0.0:7898"
moor-daemon | 2025-02-10T01:59:49.928709Z INFO moor-scheduler run: moor_kernel::tasks::scheduler: crates/kernel/src/tasks/scheduler.rs:249: No server options object found; using defaults
moor-daemon | 2025-02-10T01:59:49.928878Z INFO moor-rpc moor_daemon::rpc_server: crates/daemon/src/rpc_server.rs:161: 0mq server listening on tcp://0.0.0.0:7899 with 8 IO threads
moor-daemon | 2025-02-10T01:59:49.928989Z INFO textdump-thread moor_kernel::tasks::scheduler: crates/kernel/src/tasks/scheduler.rs:1275: Textdump written. final_path="textdump-out/textdump-1739152789.moo-textdump"
moor-web-host | 2025-02-10T01:59:49.929942Z INFO main moor_web_host: crates/web-host/src/main.rs:385: Serving out of CWD "/moor"
moor-web-host | 2025-02-10T01:59:49.930656Z INFO main rpc_async_client: crates/rpc/rpc-async-client/src/lib.rs:90: Registering host with daemon...
moor-daemon | 2025-02-10T01:59:49.931523Z INFO moor-rpc moor_daemon::rpc_server: crates/daemon/src/rpc_server.rs:315: Host v4.public.dGNwybbPDOWv9ho3ac_epyXRBRTkAH1ry6R6-laSh-US_c6WEffjWrCTw19G1xP-tnfY28Kcoavz5LDO0FhkmlkdAQ.a2V5LWlkOm1vb3JfaG9zdA registered with 0 listeners
moor-web-host | 2025-02-10T01:59:49.931697Z INFO main rpc_async_client: crates/rpc/rpc-async-client/src/lib.rs:101: Host token accepted by daemon.
moor-web-host | 2025-02-10T01:59:49.931863Z INFO tokio-runtime-worker moor_web_host: crates/web-host/src/main.rs:220: Listening on 0.0.0.0:8080
moor-web-host | 2025-02-10T01:59:49.992704Z INFO main moor_web_host: crates/web-host/src/main.rs:428: Bundle written to "./dist"
moor-daemon | 2025-02-10T01:59:50.525077Z INFO moor-rpc moor_daemon::rpc_server: crates/daemon/src/rpc_server.rs:315: Host v4.public.dGNwybbPDOWv9ho3ac_epyXRBRTkAH1ry6R6-laSh-US_c6WEffjWrCTw19G1xP-tnfY28Kcoavz5LDO0FhkmlkdAQ.a2V5LWlkOm1vb3JfaG9zdA registered with 1 listeners
moor-telnet-host | 2025-02-10T01:59:50.525354Z INFO main rpc_async_client: crates/rpc/rpc-async-client/src/lib.rs:101: Host token accepted by daemon.
moor-telnet-host | 2025-02-10T02:00:02.156939Z INFO tokio-runtime-worker moor_telnet_host::listen: crates/telnet-host/src/listen.rs:105: Accepted connection for listener addr=172.20.0.1:48874
moor-telnet-host | 2025-02-10T02:00:02.157005Z INFO tokio-runtime-worker moor_telnet_host::listen: crates/telnet-host/src/listen.rs:190: Accepted connection for listener peer_addr=172.20.0.1:48874 client_id=79476d17-d40b-4d9f-a652-024a31ef8c0f port=48874
moor-telnet-host | 2025-02-10T02:00:02.158026Z INFO tokio-runtime-worker moor_telnet_host::listen: crates/telnet-host/src/listen.rs:213: Connection established, connection ID: #-7
moor-telnet-host | 2025-02-10T02:00:02.158103Z INFO tokio-runtime-worker moor_telnet_host::listen: crates/telnet-host/src/listen.rs:243: Subscribed on pubsub events socket for 79476d17-d40b-4d9f-a652-024a31ef8c0f, socket addr tcp://moor-daemon:7898
moor-daemon | 2025-02-10T02:00:02.158302Z INFO moor-rpc moor_daemon::rpc_server: crates/daemon/src/rpc_server.rs:764: Performing Connected login for client: 79476d17-d40b-4d9f-a652-024a31ef8c0f, with args: []
moor-daemon | 2025-02-10T02:00:02.163430Z ERROR moor-rpc moor_daemon::rpc_server: crates/daemon/src/rpc_server.rs:807: Error waiting for login results error=TaskAbortedError
moor-web-host | 2025-02-10T02:00:15.836574Z INFO tokio-runtime-worker moor_web_host::host::web_host: crates/web-host/src/host/web_host.rs:222: Connection established, connection ID: #-8
moor-daemon | 2025-02-10T02:00:15.840012Z INFO moor-rpc moor_daemon::rpc_server: crates/daemon/src/rpc_server.rs:616: Detaching client client_id=307e554b-0db2-4d82-bf71-98325f9929ab

rdaum · 2025-02-10T02:25:25Z

@anubi server admin will definitely be a part of it. unfortunately this is a huge project, writing the documentation.

For your specific problem, it'd be easier to diagnose with more info if you want to join the Discord https://discord.gg/f5NnYJBfcG -- I don't see anything unusual in the logs, so I dunno what happened there.

book/src/foreword.md

book/src/introduction.md

book/src/legal.md

book/src/the-database/moo-value-types.md

rdaum · 2025-05-25T15:38:17Z

I've got a new PR at #438 which has this + some changes.

abesto requested a review from rdaum January 20, 2025 12:11

abesto force-pushed the book branch from d6fc7c5 to a4e0e32 Compare January 20, 2025 12:19

rdaum force-pushed the main branch 2 times, most recently from bc17509 to 5523a9e Compare January 25, 2025 15:11

rdaum force-pushed the book branch from 47d0d42 to 7772752 Compare February 5, 2025 17:14

abesto and others added 19 commits February 5, 2025 12:18

feat: generate mdBook from Stunt manual

10ab194

feat: expand Built-in Functions section

779e688

[book] Remove anonymous objects and WAIFs

67aea3a

[book] Syntax highlighting

6256a23

The implementation is heavily dependent on highlightjs. There are noises about mdbook replacing highlightjs with something different; if/when that happens, this will need to be ported.

[book] Individual function docs are now linkable

312c765

[book] Format all .md files

8ecaad9

[book] Normalized header levels

4a585fb

[book] Modernized function signatures

ba97424

[book] Removed Operations on Files

018b593

[book] Set up GH action publishing book to gh-pages

62baf05

[book] licensure

9ec49bc

Rewrite of the "forward" section

f9c1e0d

Removed the old ToastStunt forward. Wrote my own.

Update introduction.md

6cd8d2e

First draft here. Replace references to Toast with mooR. Tones down "virtual reality" talk a bit. Explanatory note about mooR vs LambdaMOO.

Update legal.md

ef05c1a

Remove non-relevant "threading" document

963ecfe

Rename "the-toaststunt-database" to "the-database"

d17a8a3

Rename "toaststunt-moo-resources.md" to "moo-resources.md"

cdb118b

Also removes some Toast-specific entries, adds context text, and shuffles location in the SUMMARY.md

First draft at updating the values/types section

ecd07a6

* Remove WAIFs, bools, and anonymous objects (bools may come back) * Add flyweights * Update notes about maps since mooR maps are slightly different * Update notes about maximum integers and floats.

Exempt book from dprint fmt check for now

a1119f2

rdaum force-pushed the book branch from 7772752 to a1119f2 Compare February 5, 2025 17:18

rdaum force-pushed the main branch from 7901d71 to 5ebdea7 Compare February 17, 2025 14:00

abesto commented Feb 21, 2025

View reviewed changes

rdaum force-pushed the main branch from 64dfe8a to 1dd0029 Compare February 22, 2025 13:20

rdaum force-pushed the main branch from 1dd0029 to 733b100 Compare February 22, 2025 13:23

rdaum force-pushed the main branch from 7b582de to a1c99ae Compare March 10, 2025 17:46

rdaum force-pushed the main branch 2 times, most recently from 1ec5b18 to fdf8081 Compare April 3, 2025 22:43

rdaum force-pushed the main branch from d9a8875 to 79ee2ab Compare April 11, 2025 15:08

rdaum force-pushed the main branch 3 times, most recently from 1b4b78e to ad450d0 Compare May 24, 2025 17:18

rdaum closed this May 25, 2025

abesto deleted the book branch June 15, 2025 06:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

The Moor Book, v0.1 #378

The Moor Book, v0.1 #378

Uh oh!

abesto commented Jan 20, 2025 •

edited

Loading

Uh oh!

anubi commented Feb 10, 2025

Uh oh!

rdaum commented Feb 10, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rdaum commented May 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

The Moor Book, v0.1 #378

The Moor Book, v0.1 #378

Uh oh!

Conversation

abesto commented Jan 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

!!! Required repo setup !!!

References

Uh oh!

anubi commented Feb 10, 2025

Uh oh!

rdaum commented Feb 10, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rdaum commented May 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

abesto commented Jan 20, 2025 •

edited

Loading