Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation roadmap #263

Open
12 of 31 tasks
susliko opened this issue May 15, 2020 · 2 comments
Open
12 of 31 tasks

Documentation roadmap #263

susliko opened this issue May 15, 2020 · 2 comments

Comments

@susliko
Copy link
Contributor

susliko commented May 15, 2020 •
edited
Loading

The goal of this issue is to track an overall progress over tofu documentation.
I propose the following structure:

Core

  • Error management (split into Raise, Handle/Restore pages?)
  • Forking and racing (split into Fire, Race, Start pages?)
  • Execute
  • Guarantee
  • Timeout
  • Void

Contextual

  • Env
  • Context (rename page from HasContext to Context?)

Concurrent

  • Agent
  • Atom
  • Daemon
  • GateKeeper
  • ReadWrite
  • QVar
  • MakeDeferred
  • MakeMVar
  • MakeRef
  • MakeSemaphore

Optics

  • Hierarchy
  • Contains
  • Equivalent
  • Extract
  • Folded
  • Items
  • Property
  • Subset
  • Updated

Utilities

  • Config
  • Console
  • Logging
  • Memo

Any comments are highly appreciated!
@susliko
Copy link
Contributor Author

susliko commented May 15, 2020

@Odomontois @catostrophe @danslapman

@hellboy81
Copy link

Ready to write documentation

@d1skort d1skort mentioned this issue Jun 24, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@hellboy81 @susliko