language-servers/slint
1
0
Fork 0
mirror of https://github.com/slint-ui/slint.git synced 2025-08-31 07:37:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Rename "Slint language Reference" to "Slint Language Documentation"

Browse source
This commit is contained in:
Tobias Hunger 2023-02-22 17:58:28 +01:00 • committed by Tobias Hunger
parent 8afdead15b
commit 39d215bee0
8 changed files with 9 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.github/workflows/build_docs.yaml vendored
View file

@ -83,7 +83,7 @@ jobs:
- name: "C++ Tutorial Docs"
run: mdbook build
working-directory: docs/tutorial/cpp
- name: "Slint Language Reference"
- name: "Slint Language Documentation"
run: cargo xtask slintdocs --show-warnings
- name: "Node docs"
run: |

2
.github/workflows/nightly_snapshot.yaml vendored
View file

@ -309,7 +309,7 @@ jobs:
mkdir -p snapshots/$target_branch/docs/rust
cp -a ../target/doc/* snapshots/$target_branch/docs/rust/
# Fix up link to Slint language reference
# Fix up link to Slint language documentation
sed -i "s!https://slint-ui.com/releases/.*/doc/slint!../../slint!" snapshots/$target_branch/docs/rust/slint/*.html
mkdir -p snapshots/$target_branch/docs/tutorial/rust

2
README.md
View file

@ -118,7 +118,7 @@ export component HelloWorld inherits Window {
}
```
Check out the [language reference](https://slint-ui.com/docs/slint) for more details.
Check out the [Slint Language Documentation](https://slint-ui.com/docs/slint) for more details.
## Architecture

2
api/cpp/docs/index.rst
View file

@ -71,7 +71,7 @@ of elements and property bindings. Here's the obligatory "Hello World":
}
}
Check out the `language reference <../slint>`_ for more details.
Check out the `Slint Language Documentation <../slint>`_ for more details.
Architecture
============

2
api/rs/slint/lib.rs
View file

@ -15,7 +15,7 @@ This crate is the main entry point for embedding user interfaces designed with
## Related topics
*/
#![doc = concat!("* [The Slint language reference manual](https://slint-ui.com/releases/", env!("CARGO_PKG_VERSION"), "/doc/slint)")]
#![doc = concat!("* [The Slint Language Documentation](https://slint-ui.com/releases/", env!("CARGO_PKG_VERSION"), "/doc/slint)")]
/*! * [Examples and Recipes](docs::recipes)
* [Slint on Microcontrollers](docs::mcu)
* [Debugging Techniques](docs::debugging_techniques)

2
docs/building.md
View file

@ -176,7 +176,7 @@ cargo run --release --bin slint-viewer -- examples/printerdemo/ui/printerdemo.sl
The documentation for the different crates is built using rustdoc.
The language reference has snippets in the .slint language which can be previewed by injecting
The language documentation has snippets in the .slint language which can be previewed by injecting
html to the documentation with the `--html-in-header` rustdoc flag.
Use the following command line to build the documentation to include preview of the .slint files.

4
docs/langref/index.rst
View file

@ -1,8 +1,8 @@
.. Copyright © SixtyFPS GmbH <info@slint-ui.com>
.. SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-Slint-commercial
Welcome to the Slint Language Reference
========================================
Welcome to the Slint Language Documentation
===========================================
Introduction
------------

2
internal/core/api.rs
View file

@ -513,7 +513,7 @@ pub use crate::SharedString;
/// Palette::get(&app).set_foreground_color(slint::Color::from_rgb_u8(255, 255, 255));
/// ```
///
#[doc = concat!("See also the [language reference for global singletons](https://slint-ui.com/releases/", env!("CARGO_PKG_VERSION"), "/doc/slint/src/globals.html) for more information.")]
#[doc = concat!("See also the [language documentation for global singletons](https://slint-ui.com/releases/", env!("CARGO_PKG_VERSION"), "/doc/slint/src/globals.html) for more information.")]
///
/// **Note:** Only globals that are exported or re-exported from the main .slint file will
/// be exposed in the API