Giter VIP home page Giter VIP logo

Comments (6)

JasonMorgan avatar JasonMorgan commented on June 27, 2024 1

So in the spirit of, "let's do both." I'm happy to send a PR tonight that moves the entries to yaml and expand on, or really change, issue #15 to build a single markdown file with all the combined entries. That'll at a minimum let us try the individual entry format and swap over to a single file with ease. Thoughts?

from glossary.

JasonMorgan avatar JasonMorgan commented on June 27, 2024

Happy to, are we comfortable maintaining the individual entries as their own files or do we want to combine everything back together?

from glossary.

caniszczyk avatar caniszczyk commented on June 27, 2024

from glossary.

IdealUsrname avatar IdealUsrname commented on June 27, 2024

imho keep it in one MD for now, just makes it easier

For now, it does. Maybe we are solving for too much @JasonMorgan?

Depending on the size the single document may become a lot. I'd suggest breaking the doc into a similar format with a proper table of contents.

---
##title
###category
###status
###definition
---

from glossary.

caniszczyk avatar caniszczyk commented on June 27, 2024

from glossary.

CathPag avatar CathPag commented on June 27, 2024

I agree with Michael. The Google doc was hard to navigate. My tendency was to focus on the first entries and I rarely made it to the end. Also, if you want to see the change in preview (which people not familiar with markdown may want to do), there will be a lot of scrolling involved to find the place you want to see.

I do agree that a single file is a lot nicer to review as a whole but feel that while we are still working on the individual entries, having them separate will make it easier.

How about keeping them separate and merge into one file just before V1 goes live?

from glossary.

Related Issues (20)

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.