pldb icon indicating copy to clipboard operation
pldb copied to clipboard

Every language with one should have a `documentation` keyword

Open breck7 opened this issue 3 years ago • 9 comments

Example: https://pldb.com/languages/alumina.html: documentation https://docs.alumina-lang.net/

breck7 avatar Sep 04 '22 14:09 breck7

question: should every language have a documentation keyword? or should languages only have a documentation keyword if there is a know documentation source?

cindywu avatar Sep 17 '22 19:09 cindywu

good question. a language should only have a documentation keyword if someone found a link to documentation. at some point we should also have a way to indicate that a search fro documentation was done but results were null (which is a very useful piece of information). that's a common pattern that i haven't standardized yet. maybe we need a special keyword to indicate that

breck7 avatar Sep 17 '22 20:09 breck7

Hi @breck7 , I am going to work on this issue. Just one question: As it seems we have to add docs link to language.scroll files too but as language.scroll files are in git ignore, so is this fine to forcefully add edited language.scroll files to git?

mahadwaseem123 avatar Oct 10 '22 19:10 mahadwaseem123

As it seems we have to add docs link to language.scroll files too

I'm sorry can you explain more? I'm not understanding.

fine to forcefully add edited language.scroll files to git?

No we should not do this. I think I wasn't clear in my comment above, sorry.

breck7 avatar Oct 10 '22 20:10 breck7

So @breck7 , we only need to add documentation keyword in pldb files, right?

mahadwaseem123 avatar Oct 10 '22 20:10 mahadwaseem123

documentation is just another field (a link to the documentation) just like creators or appeared or title.

breck7 avatar Oct 10 '22 20:10 breck7

Got it @breck7 , thanks a lot for the explanation. Will work on this.

mahadwaseem123 avatar Oct 10 '22 20:10 mahadwaseem123

Hi @breck7 , added documentation keyword to top 25 languages. Here is the PR #209

mahadwaseem123 avatar Oct 11 '22 18:10 mahadwaseem123

Hi @breck7 , now top 100 languages have the documentation keyword.

mahadwaseem123 avatar Oct 14 '22 19:10 mahadwaseem123

This is a great start. Closing for now.

breck7 avatar Jan 03 '23 11:01 breck7