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

docs: types need reference documentation #68

Open
jalehman opened this issue Jun 20, 2024 · 4 comments · May be fixed by #80
Open

docs: types need reference documentation #68

jalehman opened this issue Jun 20, 2024 · 4 comments · May be fixed by #80
Assignees
@bonbud-macryg

Comments

@jalehman
Copy link
Member

There are many types introduced in neo that are either new or just heavily used: kook, curb, stud, kids, dare, lads, pish, lash, form, pail, note to name a few. There should be reference documentation for these in one place.
@bonbud-macryg bonbud-macryg linked a pull request Jul 2, 2024 that will close this issue
Open
@tiller-tolbus
Copy link
Collaborator

There are some arms in sur/neo related to axals in the +of core that would be very helpful to document for purposes of writing renderers like Sky and Tree

@bonbud-macryg
Copy link

@tiller-tolbus Yeah I've scanned /sur/neo again and I'm thinking there's a lot of functionality in there that should be covered in a separate document. Maybe one doc for +of and one for using the shanes.

@bonbud-macryg
Copy link

@liam-fitzgerald When you're back could you go through types.txt in #80 and leave comments on my questions in there? If you CMD+F ??? or [ that should get all of them. Once we've filled those out the doc should cover 1) all of the types shrub devs have to think about outside of +of and shanes and 2) the types that those types are made up of.

@bonbud-macryg
Copy link

Would be nice to have anchor links in docs like this but Sky doesn't support it rn.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bonbud-macryg bonbud-macryg

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add type documentation urbit/shrub
3 participants
@jalehman @bonbud-macryg @tiller-tolbus