Commit Graph

58 Commits

Author SHA1 Message Date
translatenix
2392a3c22f Add quick link to standard library docs
Motivation:
The standard library docs are some of the most important docs
but currently very hard to find. I've noticed that even advanced
users have never heard of them and complain about "zero docs".
2024-04-05 12:38:55 +01:00
Daniel Chao
58ed8242af Fix links for downloading snapshot executables (#391)
Also, quote the URLs for better shell compatibility
2024-04-04 07:43:42 -07:00
translatenix
3bd91b92ee Fix "amends declaration vs. expression" mistakes in language reference 2024-04-03 19:06:54 +01:00
Daniel Chao
759d4806c0 Fix java/kotlin usage examples (#372)
Co-authored-by: Fruxz <28064149+TheFruxz@users.noreply.github.com>
2024-03-28 07:57:28 -07:00
Daniel Chao
c28e478d5a Fix links to pkl-go and pkl-swift repos (#364)
Using `xref` turns these links into fragments.
2024-03-27 12:30:41 -07:00
Daniel Chao
4bdfe40816 Import release notes for 0.25.3 (#365)
This adds the release notes for 0.25.3 into CHANGELOG.
2024-03-27 11:56:29 -07:00
Malix
5d0d2ce7a1 Add TOML to comparison page (#337)
Puts TOML next to JSON, XML, YAML
2024-03-19 09:14:56 -07:00
Zihlu Wang
2bf1fa215a Update pkl-config-java.adoc (#340)
Remove unpaired back curly bracket.
2024-03-19 09:13:46 -07:00
Zihlu Wang
4ce7a82db5 Removed undeclared method reference in examples. (#341)
There is no method `evaluateText` in `ConfigEvaluator` or `ConfigEvaluatorImpl`.
2024-03-19 09:13:33 -07:00
d4wae89d498
3fb1f03780 Fix missing closing quotes in Local dependencies #298 (#299)
Fix missing closing quotes in 'Local Dependencies' section of index.adoc to ensure syntax correctness.
2024-03-07 10:42:10 -08:00
Daniel Chao
4f3858aaaf Docs fix: Container is not a type, add more types (#282)
Adjusts documentation to remove legacy `Container` type,
and add the rest of the generic types in the stdlib.
2024-03-04 07:49:44 -08:00
Daniel Chao
d7196e1207 Docs fix: Java 8 is not supported (#283)
Java 11 is the minimum version, rather than 8.
2024-03-04 07:49:20 -08:00
Daniel Chao
0ae9e0c5c0 Add homebrew instructions to docs (#270) 2024-02-29 11:02:36 -08:00
Daniel Chao
b0161a4777 Add specification for language binding API (#257)
This adds documentation for how the language bindings works, for those that wish to create their own bindings.
2024-02-28 08:10:16 -08:00
translatenix
b7b0e65cc6 Delete unused image (#243)
This image is not used anywhere.
2024-02-23 14:50:48 -08:00
Zack McCauley
8f130d8d49 Fix multiple output example code (#205) 2024-02-22 10:28:23 +01:00
Islon Scherer
c652bbe5cd fix typo in doc for Listing default (#224) 2024-02-21 18:56:11 +01:00
GrantA
1cfcc5ec38 Fix incorrect filename in tutorial
The referenced filename should be `ispklTutorialPart3.pkl`, not `pklTutorial.pkl`.

Also, changes dates from 2023 to 2024

Co-authored-by: grant-abbott <gaabbott@apple.com>
2024-02-20 21:09:08 -08:00
translatenix
6175d16d6a Update Gradle syntax in docs (#210)
Replace the legacy "compile" scope with "implementation".
This matches Maven Central's recommended syntax:
https://central.sonatype.com/artifact/org.pkl-lang/pkl-core
2024-02-20 21:02:45 -08:00
Lily Ballard
bbb4d828a0 Update Reserved keywords list in the Language Reference (#171)
`const` is not reserved, it has a meaning already. And `match` is not a keyword at all.
2024-02-19 13:37:47 +01:00
Philip K.F. Hölzenspies
a49526649d Update docs/modules/language-tutorial/pages/02_filling_out_a_template.adoc 2024-02-13 21:30:18 +00:00
GrantA
1b208f852c Update docs/modules/language-tutorial/pages/02_filling_out_a_template.adoc
Co-authored-by: Philip K.F. Hölzenspies <holzensp@gmail.com>
2024-02-13 21:30:18 +00:00
GrantA
1a1d2f9908 Update docs/modules/language-tutorial/pages/02_filling_out_a_template.adoc
Co-authored-by: Philip K.F. Hölzenspies <holzensp@gmail.com>
2024-02-13 21:30:18 +00:00
grant-abbott
0b680be32b Addressing documentation discrepancies from pkl examples. 2024-02-13 21:30:18 +00:00
Hoxell
f2470f3e85 Apply suggested update to note on amending types 2024-02-13 21:16:06 +00:00
Freddy
7d9603afd7 Update docs/modules/language-tutorial/pages/02_filling_out_a_template.adoc
Co-authored-by: Philip K.F. Hölzenspies <holzensp@gmail.com>
2024-02-13 21:16:06 +00:00
Hoxell
8c254a9976 Introduce Typed objects before referring to them
Currently, typed objects are only briefly mentioned in the sentence
stating that (typed) objects cannot be amended with new properties, only
existing ones. This is unnecessarily confusing since all examples up
until that point have been concerned with dynamic objects. Since the
tutorial goes on to amend a dynamic object with a new property in the
next section, a reader who isn't yet aware there are two types of
objects might be confused by what seems to be a contradiction.
2024-02-13 21:16:06 +00:00
Les Hill
14dec716cf Add details to show amending working when using modules
Running through the tutorial, the amending was stated in the tutorial text but not visible in the tutorial output since `parrot.pkl` was replacing all the members of `pigeon.pkl`.
2024-02-13 20:56:17 +00:00
Philip K.F. Hölzenspies
b3fb5dced6 Apply suggestions from code review 2024-02-13 16:57:12 +00:00
Hoxell
4bf6d3069d Fix mislabeled object name 2024-02-13 16:57:12 +00:00
Hoxell
28d98b461b Use object name instead of 'name' property 2024-02-13 16:57:12 +00:00
Hoxell
99717c61af Pigeon -> dodo 2024-02-13 16:57:12 +00:00
Daniel Chao
6f915e5b90 Fix docs pointing to wrong maven repo (#106) 2024-02-12 08:24:22 -08:00
Dan Chao
0a3a618091 Remove line from changelog
This change got reverted prior to the release.
2024-02-08 17:33:26 -08:00
Dan Chao
5ce205c2c0 Update changelog for release 0.25.2 2024-02-08 17:33:19 -08:00
Daniel Chao
97f4193c15 Fix more links (#104)
This fixes more documentation links that are producing 404's.
2024-02-08 15:20:02 -08:00
Ricardo Pinheiro
20adac9919 Update Hidden Properties documentation (#91) 2024-02-07 21:15:53 -08:00
Daniel Chao
52bc9612ea Reword verbage to "pantry" (#64)
* Reword verbage to "pantry"

* Fix verbage
2024-02-07 19:40:43 -08:00
The L D O
5a311d3b86 update 'Loading Modules' example to match config contents (#84)
Co-authored-by: Daniel Chao <dan.chao@apple.com>
2024-02-07 17:58:57 -08:00
Adrian Lanzafame
e9df244485 fix concat operator and string typo 2024-02-07 20:23:51 +00:00
James Ward
604bb83acb Fix artifact name 2024-02-07 20:23:17 +00:00
kelvine
9bc7ada4ae fixed typo on transiti[ti]on 2024-02-07 20:09:57 +00:00
Lily Ballard
0538044fee Fix CLI docs examples for -x
The examples were using the wrong key.
2024-02-07 20:04:41 +00:00
Lily Ballard
bb3e3929ac Fix missing pkl eval subcommand in documentation examples 2024-02-07 20:04:41 +00:00
Ryosuke Hayashi
5c541aa168 Minor fix in the code of the docs 2024-02-06 16:13:10 +00:00
Islon Scherer
3f8fae4873 fix wrong stdlib doc links (#74) 2024-02-06 13:01:45 +01:00
Edward Knight
90c60c700d Fix minor discrepancy in workshop example (#60)
Map values of `agenda` should have a `name` instead of a `title` to be
consistent with the `TutorialPart` module.

Fixes #11.
2024-02-05 18:08:16 -08:00
Brian Pfeil
58e7cc188a taxonomy nesting fix 2024-02-05 14:13:31 +00:00
Scott Henson
ba52ac73da Merge pull request #44 from rex4539/typos
Fix typos
2024-02-05 13:50:32 +00:00
Philip Hölzenspies
27ecb8c389 Fix tutorial; uninterpreted value 2024-02-05 10:18:57 +00:00