Skip to content

Add examples to show how things are used. #496

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.

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

Closed
uscholdm opened this issue Jun 25, 2021 · 7 comments
Closed

Add examples to show how things are used. #496

uscholdm opened this issue Jun 25, 2021 · 7 comments
Assignees

Comments

@uscholdm
Copy link
Contributor

Put in a separate examples folder.

@uscholdm
Copy link
Contributor Author

uscholdm commented Sep 8, 2023

I am working on this.

@uscholdm
Copy link
Contributor Author

This is a very large task, given there are so many different parts of gist to illustrate. I will start somewhere and come up with some conventions for how to do this. I might start with Collections and OrderedCollections as I have some examples from client work.

@rjyounes
Copy link
Collaborator

I'd like to consider moving these to the gist-doc repository so they are not tied to our release schedule. If they are distributed with a release, it creates a lot of additional work to update the examples accordingly. Even if not distributed in a release, I think the implication would be that they are being kept up-to-date with the develop branch, surely to onerous a task when making changes to gist. The gist-doc repo can get out of sync with the current state of gist, either released or in development, without creating confusion as long as it's made clear in the readme. @pwin's documentation in that repo, for example, is not updated on the same schedule as gist.

@uscholdm
Copy link
Contributor Author

This is an excellent point.

@rjyounes
Copy link
Collaborator

rjyounes commented Sep 28, 2023

Closing - examples will reside in gist-doc repo, @uscholdm to create new issue there.

@semartsofficemanager Move documentation section higher up on SA website gist page.

@rjyounes rjyounes closed this as not planned Won't fix, can't repro, duplicate, stale Sep 28, 2023
@uscholdm
Copy link
Contributor Author

Closing - examples will reside in gist-doc repo, @uscholdm to create new issue there.

Issue created: semanticarts/gist-doc#7

@JonathonGist
Copy link

Thank you team for doing this--I can hardly wait to read it, when I get some time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants