Commit Graph

60 Commits

Author SHA1 Message Date
Stefano Baghino
354a14ea60
Make emphasis visible (#14604)
Setting the font weight to 500 makes it effectively invisible, at least
in certain configurations (my setup is an Ubuntu 20.04 with Chrome 103).

In my experiments, 600 is the minimal font weight that makes the difference
visible on my setup. In order to keep the appearance of links unchanged,
I also decreased the font weight for links to the same as the body.

Another possibility to make a compromise that could work for different
setups could be to lower the font weight for bold to 600 and have a weight
specific for links at 500. This allows emphasis to appear clearly on setups
with less sophisticated font management but not to exagerated it for links.

changelog_begin
changelog_end
2022-08-04 10:09:23 +02:00
Gary Verhaegen
7f35d3dc27
update daml.com URLs (#13226)
Requested by Olivia Yu.

CHANGELOG_BEGIN
CHANGELOG_END
2022-03-09 18:15:40 +00:00
Gary Verhaegen
dfa648f585
hunt down DAML better (#13195)
Process:

- `git ls-files -z | xargs -0 -n 100 sed -i --follow-symlinks 's/DAML/Daml/g'`
- `git add -p`
- `git restore -p`
- Check there is no unstaged change left.

To review:

- Check for false positives by carefully reviewing the diff in this PR.
- Check for false negatives with `git grep DAML`.
- Quicker check for fals positives:

```
git grep DAML | grep -v migration | grep -v DAML_
```

Fixes #13190

Note: This is the "second half" of #13191, which failed to cover all the
remaining DAMLs because of:

```
$ git ls-files | grep "'"
compiler/damlc/tests/daml-test-files/MangledScenario'.daml
```

CHANGELOG_BEGIN
CHANGELOG_END
2022-03-08 17:04:58 +01:00
Moritz Kiefer
8a966bfaf3
Upgrade sphinx (#12968)
* Upgrade sphinx

Don’t want to be stuck on 1.8.3 forever. The current version is
4.4.0 (this upgrades to 4.3.1 which is the latest in nixpkgs).

I did had to drop footnotebackref. This runs into the same issue as
https://tex.stackexchange.com/questions/137594/hyperref-footnotebackref-in-longtable
but just copying the fix doesn’t work and I don’t understand enough
about the details here to fix this myself.

We have 7 footnotes in the Daml docs + some in the Canton docs. That
does not seem worth sticking on a sphinx version from 2018 for just to
get backreferences from footnotes to the link on the same page.

changelog_begin
changelog_end

* turns out you need fonts maybe

* .

changelog_begin
changelog_end

* suppport :force: in daml-docs

changelog_begin
changelog_end
2022-02-22 14:30:15 +00:00
Bernhard Elsner
5cb672db2b
Fix docs rendering of \n in interpolated strings in TypeScript (#13015)
CHANGELOG_BEGIN
CHANGELOG_END
2022-02-22 13:43:35 +01:00
Bernhard Elsner
68c76f6723
Fix the indentation of item four levels down the docs ToC. (#13016)
CHANGELOG_BEGIN
CHANGELOG_END
2022-02-22 12:02:14 +01:00
Bernhard Elsner
0c94fd802e
Change mechanism for detecting the index page in the docs theme. (#12999)
CHANGELOG_BEGIN
CHANGLOG_END
2022-02-22 09:57:08 +00:00
Bernhard Elsner
3d7edf84a9
Fix code block rendering issues (#13002)
CHANGELOG_BEGIN
CHANGELOG_END
2022-02-21 17:13:51 +00:00
Jennifer Whyte
bdfbb0d928
Update bg color on docs sections (#12975)
Adds a background color to the floating section. Previously it was transparent and caused readability issues.

CHANGELOG_BEGIN
CHANGELOG_END
2022-02-16 12:21:26 -05:00
Jennifer Whyte
7305a8c297
Color and typography edits (#12609)
CHANGELOG_BEGIN
CHANGELOG_END
2022-01-26 17:35:01 -05:00
Gary Verhaegen
ea55ea2d14
Further copyright updates (#12249)
Somewhat error-prone, so please review carefully.

Reasons we need this:

- Some file types are not properly handled by the script.
- The only exclusion mechanism we currently have (`NO_AUTO_COPYRIGHT`)
  is overly coarse.

CHANGELOG_BEGIN
CHANGELOG_END
2022-01-04 16:32:17 +01:00
Gary Verhaegen
d2e2c21684
update copyright headers (#12240)
New year, new copyright, new expected unknown issues with various files
that won't be covered by the script and/or will be but shouldn't change.

I'll do the details on Jan 1, but would appreciate this being
preapproved so I can actually get it merged by then.

CHANGELOG_BEGIN
CHANGELOG_END
2022-01-03 16:36:51 +00:00
Bernhard Elsner
9ff8851488
Fix a docs display issue with Safari and Firefox (#12035)
CHANGELOG_BEGIN
CHANGELOG_END
2021-12-13 13:25:00 +01:00
Stefano Baghino
9ed1eb3ce3
Address security notice on ansi-regex (#11243)
* Address security notice on `ansi-regex`

Addressed this via resolution of `chalk` on a common version
which seems close enough to other old versions not to break
anything (tested manually) while removing the `ansi-regex`
transitive dependency that causes our daily builds to break.

Also removed `package-lock.json` since we are using `yarn`.

changelog_begin
changelog_end
2021-10-14 11:15:34 +00:00
Moritz Kiefer
7c1fd50469
Bump grunt-browserify (#11026)
Missed it in #11023

changelog_begin
changelog_end
2021-09-27 09:03:35 +00:00
Moritz Kiefer
91be1e1659
Drop matchdep dependency from docs build (#11023)
We really don’t need 600 lines of mostly deprecated and unmaintained
dependencies which get flagged by blackduck & dependabot if we can
inline this into a static array which we never changed since we first
added the docs.

changelog_begin
changelog_end
2021-09-27 09:48:00 +02:00
Bernhard Elsner
24116e4fa2
Minor docs fixes (#8662)
* Fix copyright messages.

The (C) Copyright gets inserted automatically.

CHANGELOG_BEGIN
CHANGELOG_END

* Update favicons

* Reduce z-indices

* Improve inline search hover effect

* Avoid putting "null" in the search bar

* Address Gary's feedback

* Remove pycache

* Improve gitignore

* Change © to (c)
2021-01-29 08:42:36 +00:00
Gary Verhaegen
3e8d474b4b
docs: fix URL parsing for search page (#8618)
CHANGELOG_BEGIN
CHANGELOG_END
2021-01-25 15:03:57 +00:00
Gary Verhaegen
ce8c38bac1
copyright updates (#8610)
CHANGELOG_BEGIN
CHANGELOG_END
2021-01-22 15:03:36 +00:00
Bernhard Elsner
34fe171c46
Change case of DAML on docs landing page (#8600)
CHANGELOG_BEGIN
CHANGELOG_END
2021-01-22 13:03:33 +00:00
Bernhard Elsner
64f85ae8f6
Fix docs logo (#8446)
CHANGELOG_BEGIN
CHANGELOG_END
2021-01-11 08:44:02 +00:00
Bernhard Elsner
cda93db944
Daml case and logo (#8433)
* Replace many occurrences of DAML with Daml

* Update docs logo

* A few more CLI occurrences

CHANGELOG_BEGIN
- Change DAML capitalization and docs logo
CHANGELOG_END

* Fix some over-eager replacements

* A few mor occurrences in md files

* Address comments in *.proto files

* Change case in comments and strings in .ts files

* Revert changes to frozen proto files

* Also revert LF 1.11

* Update get-daml.sh

* Update windows installer

* Include .py files

* Include comments in .daml files

* More instances in the assistant CLI

* some more help texts
2021-01-08 12:50:15 +00:00
Gary Verhaegen
427179ab27
fix (some) copyright headers (#8422)
This commit fixes a few copyright headers that have been missed in the
automatic update on Jan 1, as well as the generation code in the compat
workspace so it generates the right headers.

CHANGELOG_BEGIN
CHANGELOG_END
2021-01-07 11:48:59 +01:00
Gary Verhaegen
a925f0174c
update copyright notices for 2021 (#8257)
* update copyright notices for 2021

To be merged on 2021-01-01.

CHANGELOG_BEGIN
CHANGELOG_END

* patch-bazel-windows & da-ghc-lib
2021-01-01 19:49:51 +01:00
Bernhard Elsner
7f81db4fc4
Add build rule for DAML Driver for PostgreSQL docs (#8188)
* Add build rule for DAML Driver for PostgreSQL docs

CHANGELOG_BEGIN
CHANGELOG_END

* Reimplement some JS functions

* fmt

changelog_begin
changelog_end

Co-authored-by: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>
2020-12-08 10:19:48 +00:00
Bernhard Elsner
ec41bb2652
Small sizing and alignment fixes (#8171)
CHANGELOG_BEGIN
CHANGELOG_END
2020-12-04 15:16:50 +00:00
Bernhard Elsner
0059844349
Fix Next button padding (#8168)
CHANGELOG_BEGIN
CHANGELOG_END
2020-12-04 13:38:31 +00:00
Bernhard Elsner
503600f5d0
Docs style alignment (#8164)
* Update landing page icons

CHANGELOG_BEGIN
CHANGELOG_END

* Fix menu arrow alignment

* Fix the colour of the icons

* Improve landing page specing
2020-12-04 13:43:44 +01:00
Bernhard Elsner
f0b98a85b9
Docs style alignment (#8134)
* Flashier top-level menu

* Flashy buttons

CHANGELOG_BEGIN
CHANGELOG_END

* Increase top-level nav font-size

* Make the entire landing page box clickable

* Fix code block alignment and copy button with line numbers

* Fix code blocks with line numbers on mobile

* Reengineer code blocks properly

* More fixes to code-blocks

* Add a vertical line after line numbers
2020-12-04 08:50:08 +01:00
Bernhard Elsner
d40f2493ab
Docs style alignment (#8074)
* Docs restyle WIP

* Minor color changes

* Adjust fonts and shadows

* Remove redundant local contents

* Further fixes to "In this Section"

* Restyle previous and next buttons

* Make visited link color blue

* Top-level nav

* Change how anchors are underlined

* Fix header spacing

* Improve tables

* Improve search results

* Improve copy button

Match sphinx versions between dev-env and bazel

* Copy button and code block fixes

* Fix copy button z-index

* Making things reactive

* Make the title spacing work on mobile & tablet

* Pixel adjustment for S3 hosting

* Spacing and font-size fixes

* Fix content menu for tablet

* Tidy up menu indentation

* Reorder Mobile Menu

* Move unified nav up

CHANGELOG_BEGIN
[Docs] New styling
CHANGELOG_END

* Remove non-free fonts

* Fix button padding

* Fix spacing above first h2

* Fix pixel adjustment of h1 line

* Fix menu click effects and antialiasing

* Pixel adjust h1 line once more
2020-11-30 17:16:26 +00:00
Bernhard Elsner
0f54a0cbdb
Remove the examples page from the docs in favour of one on daml.com (#8090)
* Remove the examples page from the docs in favour of one on daml.com

CHANGELOG_BEGIN
CHANGELOG_END

* Fix link from /samples to /examples

* Fix link in daml intro

* Fix link, second try
2020-11-30 15:37:15 +01:00
Nemanja
6a452c184f
Positioning the 'Next' buttonn so it doesn't overlap with other elements (#7716)
* Positioning the 'Next' buttonn so it doesn't overlap with other elements

* CHANGELOG_BEGIN
CHANGELOG_END
2020-10-16 18:42:33 +02:00
Gary Verhaegen
051b0b515e
remove mailchim popup code (#7424)
After discussion we have decided to introduce such popups through Google
Tag Manager, as the release schedule fo these sorts of JS tags does not
mesh well with the current release process of our docs site.

CHANGELOG_BEGIN
CHANGELOG_END
2020-09-16 16:28:38 +00:00
anthonylusardi-da
54ad2adf06
Remove hubspot mailing list popup and replace with mailchimp (#7408)
* Remove hubspot mailing list popup and replace with mailchimp

* CHANGELOG_BEGIN
CHANGELOG_END
2020-09-16 09:01:23 -04:00
anthonylusardi-da
3d067b5fa9
Fix some screen widths not showing the content menu collapse/expand icon (#7138)
* Fix some screen widths/zoom levels not showing the content menu collapse/expand icon

* CHANGELOG_BEGIN
[Docs] Fix some screen widths not showing the content menu collapse/expand icon
CHANGELOG_END
2020-08-19 16:37:47 -04:00
Moritz Kiefer
ee74551642
Add previous/next buttons to the documentation (#6811)
fixes #6701

changelog_begin
changelog_end
2020-07-21 17:14:33 +02:00
Nemanja
77c0b879e6
Copy code button (#6508)
* Copy code button

Added the sphinx copy code extension (https://sphinx-copybutton.readthedocs.io/en/latest/) to the docs. Tested with  and it worked.

CHANGELOG_START
CHANGELOG_END

* Remove vendored copy of sphinx_copybutton

changelog_begin
changelog_end

* remove debugging output

changelog_begin
changelog_end

Co-authored-by: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>
2020-06-29 12:34:40 +02:00
Nemanja
c7c94ab70d
Feedback button (#6500)
* 'Thumbs up/down' and 'Feedback'  button fix

Changed the position of the 'Thumbs up/down' button to be in the bottom right corner above the 'Feedback' button. Added SASS to remove both buttons for mobile (as we were getting a lot of gibberish feedback

CHANGELOG_START
CHANGELOG_END

* 'Thumbs up/down' and 'Feedback'  button fix

Changed the position of the 'Thumbs up/down' button to be in the bottom right corner above the 'Feedback' button. Added SASS to remove both buttons for mobile (as we were getting a lot of gibberish feedback

CHANGELOG_START
CHANGELOG_END

* Putting some of the blocks where they were
2020-06-26 12:33:53 +02:00
Brian Healey
6ad3279bbd
upgrade elliptic version to address vulnerability (#6459)
* upgrade elliptic version to address vulnerability

* Revert "upgrade elliptic version to address vulnerability"

This reverts commit dbf19c32

* upgrade elliptic version to address vulnerability

CHANGELOG_BEGIN
CHANGELOG_END
Signed-off-by: Brian Healey <brian.healey@digitalasset.com>

* Use range for elliptic rather than specific version
2020-06-23 12:00:01 -04:00
Brian Healey
b03cf7b598
update various yarn lock and package json files to resolve security vulnerabilities (#6319)
* update various lock files

CHANGELOG_BEGIN
CHANGELOG_END

Signed-off-by: Brian Healey <brian.healey@digitalasset.com>

* further version upticks from yarn upgrade
2020-06-12 11:35:37 -04:00
Brian Healey
d0304fb7aa
Upgrade yarn dependencies (#6300)
* upgrade npm libraries to address security vulnerabilities

CHANGELOG_BEGIN
Address npm library versions to address potential security
vulnerabilities
CHANGELOG_END
Signed-off-by: Brian Healey <brian.healey@digitalasset.com>

* format bazel
2020-06-11 13:36:40 -04:00
Brian Healey
93a9f7e36d
Add lock file so that npm ls --json will work correctly (#5644)
CHANGELOG_BEGIN
CHANGELOG_END
2020-04-21 08:44:54 -04:00
Nemanja
aee8a2485f
Added screenshots to the GSG (#5233)
* Added screenshots to the GSG

CHANGELOG_BEGIN
CHANGELOG_END

* Added copyright headers to theme/conf.py
2020-03-31 15:05:09 +02:00
Gary Verhaegen
1872c668a5
replace DAML Authors with DA in copyright headers (#5228)
Change requested by Manoj.

CHANGELOG_BEGIN
CHANGELOG_END
2020-03-27 01:26:10 +01:00
Nemanja
ff926d0a0f
TypeScript lexer for TS syntax highlighting (#4900)
* Resolves #4304

Added highlighting to the application architecture section

Highlighter that works

The latest highlighter

* Added the lexer to pdf and html and restructured how conf.py is called within the theme

* Added copyright headers

* add typescript.py to srcs

changelog_begin
changelog_end

Co-authored-by: Moritz Kiefer <moritz.kiefer@purelyfunctional.org>
2020-03-13 16:46:23 +01:00
Robin Krom
0e046d9eca
docs: new recommend path architecture documentation (#4795)
CHANGELOG_BEGIN
CHANGELOG_END
2020-03-09 12:15:37 +01:00
Moritz Kiefer
29ac82ae1c
Make hijacked docs links update the location hash (#4535)
If you click on a section title, we hijack the link to animate
it. However, we did not update the location hash. This makes it quite
annoying to copy links to a specific section.

This PR sets the jquery animate callback to update the hash as
well. I’ve also included a small fix for the link on the section title
which previously produced an error in the JS console since "#" is not
a valid jquery selector.

changelog_begin
changelog_end
2020-02-17 10:32:25 +01:00
Gary Verhaegen
8811006617
docs cron: more reliable checksums (#4102)
The docs build is currently not reproducible as it include to-the-minute
time-of-build information. It also includes some Sphinx binary caches
which I suppose will also not be reproducible (though I have not checked
the details there).

This commit attempts to remove all sources of non-reproducibility from
the docs build, though this is hard to test without having a stable,
older release to compare with.

CHANGELOG_BEGIN
CHANGELOG_END
2020-01-20 16:21:34 +01:00
Gary Verhaegen
878429e3bf
update copyright notices to 2020 (#3939)
copyright update 2020

* update template
* run script: `dade-copyright-headers update .`
* update script
* manual adjustments
* exclude frozen proto files from further header checks (by adding NO_AUTO_COPYRIGHT files)
2020-01-02 21:21:13 +01:00
Stefano Baghino
e296cebada
Improve auth docs (#3804)
- Document claims and what is required to access each service
- Refer to claims documentation in the JWT docs for the sandbox
- Fix a few typos
- Specify a single padding value for all table elements (CSS)

CHANGELOG_BEGIN

- [Documentation] Added documentation for authorization claims

CHANGELOG_END
2019-12-10 21:34:47 +01:00