GithubHelp home page GithubHelp logo

Document syntax trees about ideas HOT 5 CLOSED

wooorm avatar wooorm commented on June 20, 2024 1
Document syntax trees

from ideas.

Comments (5)

Murderlon avatar Murderlon commented on June 20, 2024 2

My caution is that we could end up writing yet another book on syntax trees, that largely duplicates existing resources.

Valid concern, I'd say some of the jargon and precise technicalities are beyond the scope here.

We may be able to link out to external references for tree traveral and syntax trees, and primarily offer recipes on how those concepts translate into Unifed.js examples.

Exactly.

@Murderlon would you be interested in creating some blog posts on some specific use-cases for Unified?

Coincidentally, this is what @wooorm and I have been talking about on what I should focus on. I'm currently thinking most about centralizing docs and guides on https://unified.js.org V2, which includes writing about syntax trees. As this is beyond the scope of just documenting syntax trees, I've created a new issue (does relate to #7): unifiedjs/unifiedjs.github.io#7

from ideas.

Murderlon avatar Murderlon commented on June 20, 2024 1

I would definitely like to see a more introductory guide to syntax trees that isn't a technical specification or glossary. In terms of it's form/design, I'm not sure a book like Babel is the right choice here. It scares me that it takes a book to understand babel while not all parts are may be relevant to what brought me there. On one hand it's nice to have a continuously evolving single-source of truth that encapsulates not just syntax trees, but also their context in the ecosystem. On the other hand interlinked single-purpose guides might be easier to consume.

Personally, I've always preferred highly specific (and therefor short) articles and the like. The question for me though it whether syntax trees is still too big for a single guide/readme? Can it be split up? Introduction vs. working with them?

from ideas.

ChristianMurphy avatar ChristianMurphy commented on June 20, 2024 1

I would definitely like to see a more introductory guide to syntax trees that isn't a technical specification or glossary. In terms of it's form/design

I completely agree.

I'm not sure a book like Babel is the right choice here. It scares me that it takes a book to understand babel

There are a lot of resources on syntax trees, the subject area is pretty large.
Having a book makes sense, people don't need to read all of it to get started.
Yet people who want to do a deep dive can leverage it as an exhaustive reference.
My caution is that we could end up writing yet another book on syntax trees, that largely duplicates existing resources.

The Can it be split up? Introduction vs. working with them?

I think we may be able to
We may be able to link out to external references for tree traveral and syntax trees, and primarily offer recipes on how those concepts translate into Unifed.js examples.

Personally, I've always preferred highly specific (and therefor short) articles and the like.

This sounds like a blog.
@Murderlon would you be interested in creating some blog posts on some specific use-cases for Unified?

from ideas.

wooorm avatar wooorm commented on June 20, 2024

/CC @ChristianMurphy

from ideas.

ChristianMurphy avatar ChristianMurphy commented on June 20, 2024

Thanks for starting the discussion @wooorm !
We're in the process unifying ideas in with discussions unifiedjs/collective#44
If you'd like to continue this thread, or start a new one https://github.com/syntax-tree/unist/discussions/categories/ideas will be the home for ideas going forward.

from ideas.

Related Issues (10)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.