馃殌 New SynapSeq website and complete SPSQ documentation #238
ruanklein
announced in
Announcements
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Along with the redesigned website, I'm happy to finally say something that has taken much longer than it probably should have:
SynapSeq now has complete documentation for the SPSQ language.
馃憠 https://synapseq.org/docs/spsq/
SPSQ documentation
This is the first time SPSQ has been documented in one complete, structured, and canonical place.
There have been several attempts to organize the documentation over the lifetime of the project: inside the repository, across different Markdown files, on earlier versions of the website, and at one point even inside the CLI itself (argh!).
That made documentation harder to maintain and, more importantly, made it unclear which source should be considered authoritative.
The new SPSQ documentation changes that.
It now covers the language from its basic structure to its more advanced features, including:
Each feature includes its syntax, parameter constraints, behavior, and examples where appropriate.
The old
SYNTAX.mddocumentation has been removed from the repository. From now on, the website documentation is the canonical source for the SPSQ language.The repository will continue to contain
GRAMMAR.mdas a compact grammar reference, but language documentation itself lives on the website.A new home for SynapSeq
The new website is also intended to make SynapSeq easier to discover and understand without having to navigate the repository first.
It includes:
Visit it here:
https://synapseq.org/
What's next?
Documentation will now evolve alongside SPSQ itself. New syntax and language features should be documented on the website as part of their development rather than being scattered across multiple sources.
I also want to continue improving the SynapSeq ecosystem (Remote, CLI, Go Library, etc) and make it easier for the community to share SPSQ sequences in the future.
If you use SynapSeq, this is also a good time to take another look at the documentation. There are quite a few features in SPSQ today, and some of them may be easier to discover now than they were through the old documentation.
All reactions