From 93a60daa24e200c2b68a07815cd79dbdfa29457d Mon Sep 17 00:00:00 2001 From: Keavon Chambers Date: Tue, 7 Jan 2025 17:17:19 -0800 Subject: [PATCH] Comprehensively update user manual and contributor guide, add Adam to core team --- .github/workflows/website.yml | 2 +- Cargo.toml | 2 +- frontend/assets/LICENSE.md | 2 +- website/config.toml | 16 +- website/config_prod.toml | 17 ++ website/content/_index.md | 51 ++--- website/content/about.md | 41 ++-- ...01-looking-back-on-2023-and-what's-next.md | 6 +- ...s-announcing-participation-in-gsoc-2024.md | 6 +- website/content/donate.md | 2 +- website/content/features.md | 16 +- website/content/learn/_index.md | 18 +- website/content/learn/_todo/graph/_index.md | 13 -- .../learn/_unpublished/graph/_index.md | 34 +++ .../{_todo => _unpublished}/graph/layers.md | 0 .../{_todo => _unpublished}/graph/nodes.md | 0 .../interface/layers-panel.md | 2 +- .../interface/properties-panel.md | 0 .../node-catalog/_index.md | 0 .../node-catalog/raster-nodes.md | 0 .../node-catalog/vector-nodes.md | 0 .../raster-editing/_index.md | 0 .../raster-editing/layers.md | 0 .../raster-editing/nodes.md | 0 .../{_todo => _unpublished}/tools/_index.md | 0 .../tools/general-tools.md | 0 .../tools/raster-tools.md | 0 .../tools/vector-tools.md | 0 .../vector-editing/_index.md | 0 .../vector-editing/layers.md | 0 .../vector-editing/nodes.md | 0 .../viewport/_index.md | 0 .../viewport/artboards.md | 0 .../viewport/navigation.md | 0 .../workflows/_index.md | 0 .../workflows/imaginate.md | 2 +- .../workflows/procedural-editing.md | 0 website/content/learn/interface/_index.md | 33 +-- .../content/learn/interface/document-panel.md | 131 ++++------- website/content/learn/interface/menu-bar.md | 96 ++++---- website/content/learn/introduction/_index.md | 4 +- .../introduction/features-and-limitations.md | 66 +++--- website/content/logo.md | 2 +- website/content/volunteer/_index.md | 4 +- website/content/volunteer/guide/_index.md | 2 +- .../product-design/_index.md | 0 .../product-design/glossary-of-terminology.md | 10 +- .../product-design/product-outline.md | 4 +- .../product-design/uses-and-workflows.md | 0 .../project-setup/knowing-your-tooling.md | 20 ++ .../guide/codebase-overview/_index.md | 212 +++++++++++++++++- .../guide/codebase-overview/code-structure.md | 84 ------- .../contributing-guidelines.md | 47 ---- .../guide/codebase-overview/debugging-tips.md | 36 +++ .../guide/codebase-overview/debugging.md | 30 --- .../getting-started/editor-and-tooling.md | 14 -- .../guide/getting-started/getting-help.md | 14 -- .../guide/getting-started/picking-a-task.md | 12 - .../volunteer/guide/graphene/_index.md | 7 +- .../guide/graphene/networks-and-nodes.md | 4 +- .../_index.md | 22 +- .../volunteer/guide/projects/_index.md | 30 --- .../volunteer/guide/starting-a-task/_index.md | 16 ++ .../code-quality-guidelines.md | 61 +++++ .../submitting-a-contribution.md | 107 +++++++++ .../_index.md} | 17 +- website/sass/about.scss | 50 ++--- website/sass/base.scss | 5 + website/static/css/balance-text.css | 18 ++ .../js/{image-interaction.js => carousel.js} | 97 +------- website/static/js/image-comparison.js | 57 +++++ website/static/js/video-autoplay.js | 21 ++ .../js/{video-embed.js => youtube-embed.js} | 0 website/templates/article.html | 4 +- website/templates/base.html | 49 ++-- website/templates/macros/replacements.html | 2 +- 76 files changed, 932 insertions(+), 686 deletions(-) create mode 100644 website/config_prod.toml delete mode 100644 website/content/learn/_todo/graph/_index.md create mode 100644 website/content/learn/_unpublished/graph/_index.md rename website/content/learn/{_todo => _unpublished}/graph/layers.md (100%) rename website/content/learn/{_todo => _unpublished}/graph/nodes.md (100%) rename website/content/learn/{ => _unpublished}/interface/layers-panel.md (96%) rename website/content/learn/{ => _unpublished}/interface/properties-panel.md (100%) rename website/content/learn/{_todo => _unpublished}/node-catalog/_index.md (100%) rename website/content/learn/{_todo => _unpublished}/node-catalog/raster-nodes.md (100%) rename website/content/learn/{_todo => _unpublished}/node-catalog/vector-nodes.md (100%) rename website/content/learn/{_todo => _unpublished}/raster-editing/_index.md (100%) rename website/content/learn/{_todo => _unpublished}/raster-editing/layers.md (100%) rename website/content/learn/{_todo => _unpublished}/raster-editing/nodes.md (100%) rename website/content/learn/{_todo => _unpublished}/tools/_index.md (100%) rename website/content/learn/{_todo => _unpublished}/tools/general-tools.md (100%) rename website/content/learn/{_todo => _unpublished}/tools/raster-tools.md (100%) rename website/content/learn/{_todo => _unpublished}/tools/vector-tools.md (100%) rename website/content/learn/{_todo => _unpublished}/vector-editing/_index.md (100%) rename website/content/learn/{_todo => _unpublished}/vector-editing/layers.md (100%) rename website/content/learn/{_todo => _unpublished}/vector-editing/nodes.md (100%) rename website/content/learn/{_todo => _unpublished}/viewport/_index.md (100%) rename website/content/learn/{_todo => _unpublished}/viewport/artboards.md (100%) rename website/content/learn/{_todo => _unpublished}/viewport/navigation.md (100%) rename website/content/learn/{_todo => _unpublished}/workflows/_index.md (100%) rename website/content/learn/{_todo => _unpublished}/workflows/imaginate.md (99%) rename website/content/learn/{_todo => _unpublished}/workflows/procedural-editing.md (100%) rename website/content/volunteer/guide/{ => _unpublished}/product-design/_index.md (100%) rename website/content/volunteer/guide/{ => _unpublished}/product-design/glossary-of-terminology.md (95%) rename website/content/volunteer/guide/{ => _unpublished}/product-design/product-outline.md (96%) rename website/content/volunteer/guide/{ => _unpublished}/product-design/uses-and-workflows.md (100%) create mode 100644 website/content/volunteer/guide/_unpublished/project-setup/knowing-your-tooling.md delete mode 100644 website/content/volunteer/guide/codebase-overview/code-structure.md delete mode 100644 website/content/volunteer/guide/codebase-overview/contributing-guidelines.md create mode 100644 website/content/volunteer/guide/codebase-overview/debugging-tips.md delete mode 100644 website/content/volunteer/guide/codebase-overview/debugging.md delete mode 100644 website/content/volunteer/guide/getting-started/editor-and-tooling.md delete mode 100644 website/content/volunteer/guide/getting-started/getting-help.md delete mode 100644 website/content/volunteer/guide/getting-started/picking-a-task.md rename website/content/volunteer/guide/{getting-started => project-setup}/_index.md (72%) delete mode 100644 website/content/volunteer/guide/projects/_index.md create mode 100644 website/content/volunteer/guide/starting-a-task/_index.md create mode 100644 website/content/volunteer/guide/starting-a-task/code-quality-guidelines.md create mode 100644 website/content/volunteer/guide/starting-a-task/submitting-a-contribution.md rename website/content/volunteer/guide/{projects/student-projects.md => student-projects/_index.md} (96%) create mode 100644 website/static/css/balance-text.css rename website/static/js/{image-interaction.js => carousel.js} (79%) create mode 100644 website/static/js/image-comparison.js create mode 100644 website/static/js/video-autoplay.js rename website/static/js/{video-embed.js => youtube-embed.js} (100%) diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml index fc9a2f117..1078cf9ea 100644 --- a/.github/workflows/website.yml +++ b/.github/workflows/website.yml @@ -40,7 +40,7 @@ jobs: - name: 🌐 Build Graphite website with Zola run: | cd website - zola build + zola --config config_prod.toml build - name: 🔍 Check if `website/other` directory changed uses: dorny/paths-filter@v3 diff --git a/Cargo.toml b/Cargo.toml index 610a81fcf..ddadae57a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -63,7 +63,7 @@ spirv-std = { git = "https://github.com/Rust-GPU/rust-gpu.git" } wgpu-types = "23" wgpu = "23" once_cell = "1.13" # Remove when `core::cell::LazyCell` () is stabilized in Rust 1.80 and we bump our MSRV -wasm-bindgen = "=0.2.99" # NOTICE: ensure this stays in sync with the `wasm-bindgen-cli` version in `website/content/volunteer/guide/getting-started/_index.md`. We pin this version because wasm-bindgen upgrades may break various things. +wasm-bindgen = "=0.2.99" # NOTICE: ensure this stays in sync with the `wasm-bindgen-cli` version in `website/content/volunteer/guide/project-setup/_index.md`. We pin this version because wasm-bindgen upgrades may break various things. wasm-bindgen-futures = "0.4" js-sys = "=0.3.76" web-sys = "=0.3.76" diff --git a/frontend/assets/LICENSE.md b/frontend/assets/LICENSE.md index b2ef7217e..0d2e4c34c 100644 --- a/frontend/assets/LICENSE.md +++ b/frontend/assets/LICENSE.md @@ -1,4 +1,4 @@ -Copyright (c) 2021-2023 Graphite Labs, LLC. +Copyright (c) 2021-2025 Graphite Labs, LLC. The design assets in this directory (including SVG code for icons and logos) are NOT licensed under the Apache 2.0 license terms applied to other Graphite source code files. This directory and its entire contents are excluded from the Apache 2.0 source code license, and full copyright is held by the rightsholder for the creative works contained as files herein. diff --git a/website/config.toml b/website/config.toml index 1de773a45..3234f68f9 100644 --- a/website/config.toml +++ b/website/config.toml @@ -1,19 +1,17 @@ -# The URL the site will be built for -base_url = "https://graphite.rs" - -# Whether to automatically compile all Sass files in the sass directory -compile_sass = true - title = "Graphite" description = "2D raster & vector editor that melds traditional layers & tools with a modern node-based procedural workflow." +base_url = "https://graphite.rs" feed_filenames = ["rss.xml"] +compile_sass = true +minify_html = false + [markdown] -# Whether to do syntax highlighting -# Theme can be customized by setting the `highlight_theme` variable to a theme supported by Zola highlight_code = true highlight_theme = "css" -highlight_themes_css = [{ theme = "kronuz", filename = "syntax-highlighting.css" }] +highlight_themes_css = [ + { theme = "kronuz", filename = "syntax-highlighting.css" }, +] [extra] # Put all your custom variables here diff --git a/website/config_prod.toml b/website/config_prod.toml new file mode 100644 index 000000000..9287f64b3 --- /dev/null +++ b/website/config_prod.toml @@ -0,0 +1,17 @@ +title = "Graphite" +description = "2D raster & vector editor that melds traditional layers & tools with a modern node-based procedural workflow." +base_url = "https://graphite.rs" +feed_filenames = ["rss.xml"] + +compile_sass = true +minify_html = true + +[markdown] +highlight_code = true +highlight_theme = "css" +highlight_themes_css = [ + { theme = "kronuz", filename = "syntax-highlighting.css" }, +] + +[extra] +# Put all your custom variables here diff --git a/website/content/_index.md b/website/content/_index.md index bfa2106e3..359a4cef8 100644 --- a/website/content/_index.md +++ b/website/content/_index.md @@ -1,10 +1,11 @@ +++ -title = "Web-based vector graphics editor and design tool" +title = "Free online vector editor & procedural design tool" template = "section.html" [extra] -css = ["index.css"] -js = ["image-interaction.js", "video-embed.js"] +css_inline = ["index.css"] +js = ["carousel.js", "youtube-embed.js", "video-autoplay.js"] +meta_description = "Open source free software. A vector graphics creativity suite with a clean, intuitive interface. Opens instantly (no signup) and runs locally in a browser. Exports SVG, PNG, JPG." +++ @@ -21,7 +22,7 @@ js = ["image-interaction.js", "video-embed.js"]

Your procedural toolbox for 2D content creation

-

Graphite is a free, open source vector and raster graphics engine, available now in alpha. Get creative with a nondestructive editing workflow that combines layer-based compositing with node-based generative design.

+

Graphite is a free, open source vector and raster graphics editor, available now in alpha. Get creative with a nondestructive editing workflow that combines layer-based compositing with node-based generative design.

@@ -95,7 +96,7 @@ js = ["image-interaction.js", "video-embed.js"]
- - - - - - - + + + + +