canary
/
canary-rs
2
1
Fork 0
Code Issues 11 Pull Requests 2 Projects Releases Wiki Activity

Documentation prep for launch #3

Merged
mars merged 6 commits from docs into main 2022-10-25 22:56:15 +00:00
Conversation 2 Commits 6 Files Changed 27 +195
mars commented 2022-08-07 22:52:07 +00:00
Owner
Copy Link

The objective of this PR is to comprehensively document and describe the goals, internals, expectations, and development plan for Canary, so that it can be launched into the wide world out there while pre-emptively minimizing the confusion caused by onboarding and overeager newbies.

The objective of this PR is to comprehensively document and describe the goals, internals, expectations, and development plan for Canary, so that it can be launched into the wide world out there while pre-emptively minimizing the confusion caused by onboarding and overeager newbies.
mars added this to the Launch milestone 2022-08-07 22:52:07 +00:00
mars self-assigned this 2022-08-07 22:52:07 +00:00
mars added 1 commit 2022-08-07 22:52:08 +00:00
mars commented 2022-08-07 22:57:27 +00:00
Author
Owner
Copy Link

Not ready for review yet. I still need to fill out immediately relevant parts of the book, and work on documenting the existing code.

Not ready for review yet. I still need to fill out immediately relevant parts of the book, and work on documenting the existing code.
mars added 1 commit 2022-08-12 23:05:58 +00:00
mars added 1 commit 2022-08-17 02:07:30 +00:00
mars added 2 commits 2022-09-05 06:56:42 +00:00
lilithium-hydride added 1 commit 2022-09-12 18:02:22 +00:00
mars commented 2022-10-25 22:55:55 +00:00
Author
Owner
Copy Link

Merging early just to get this PR out of the list. I will open smaller PRs to add relevant docs sections.

Merging early just to get this PR out of the list. I will open smaller PRs to add relevant docs sections.
mars closed this pull request 2022-10-25 22:55:57 +00:00
mars reopened this pull request 2022-10-25 22:56:05 +00:00
mars changed title from WIP: Documentation prep for launch to Documentation prep for launch 2022-10-25 22:56:08 +00:00
mars merged commit d5b7ffc9d2 into main 2022-10-25 22:56:15 +00:00
mars deleted branch docs 2022-10-25 22:56:15 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
abi change

Breaking ABI change between scripts and host.

  
api change

Changes the interfaces between crates.

  
bug

Unintended behavior.

  
cleanup

Code maintenance, QOL improvements, and refactors.

  
consistency

Keeps all components in sync.

  
feature

To do with new features.

  
performance

Performance improvements.

  
updates docs

Requires a change to the documentation.

No Label
abi change
api change
bug
cleanup
consistency
feature
performance
updates docs
Milestone
Clear milestone
No items
No Milestone
Launch
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
mars
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: canary/canary-rs#3
No description provided.
Delete Branch "docs"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?