Skip to content

Commit

Permalink
Add selenite logo and more pages
Browse files Browse the repository at this point in the history
  • Loading branch information
ShaitanLyss committed Aug 8, 2024
1 parent 3152a76 commit 701150c
Show file tree
Hide file tree
Showing 11 changed files with 120 additions and 7 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ on:
types: [created]

env:
SITE_ORIGIN: https://selenite-geos.github.io
BASE_PATH: '/docs'
SITE_ORIGIN: https://${{github.repository_owner}}.github.io
BASE_PATH: '/${{ github.event.repository.name }}'

jobs:
build:
Expand Down
13 changes: 9 additions & 4 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,21 @@ else
console.warn('SITE_ORIGIN is not specified. A sitemap will not be generated.');
console.log('BASE_PATH', BASE_PATH);


const dev = import.meta.env.MODE === 'development';
// https://astro.build/config
export default defineConfig({
site: SITE_ORIGIN,
base: BASE_PATH,
trailingSlash: 'never',
integrations: [
starlight({
title: 'Selenite Docs',
title: 'Docs',
logo: {
light: '@assets/selenite-logo-black.svg',
dark: '@assets/selenite-logo-white.svg',
},
editLink: true ? {
baseUrl: 'https://github.com/Selenite-GEOS/docs/edit/main/',
} : undefined,
// social: {
// github: 'https://github.com/withastro/starlight',
// },
Expand Down Expand Up @@ -80,6 +86,5 @@ export default defineConfig({
},
server: {
port: 4444,
host: true
}
});
28 changes: 28 additions & 0 deletions src/assets/selenite-logo-black.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions src/assets/selenite-logo-white.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions src/content/docs/advanced-interface/macro-blocks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Macro Blocks
description: A guide about how to use a graph editor
sidebar:
order: 3
---

Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
Writing a good guide requires thinking about what your users are trying to do.

## Further reading

- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
12 changes: 12 additions & 0 deletions src/content/docs/advanced-interface/nodes-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Nodes Overview
description: A guide about how to use a graph editor
sidebar:
order: 2
---

Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
Writing a good guide requires thinking about what your users are trying to do.

## Further reading
- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
13 changes: 13 additions & 0 deletions src/content/docs/advanced-interface/visual-programming.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Visual programming
description: A guide about how to use a graph editor
sidebar:
order: 1
---

Guides lead a user through a specific task they want to accomplish, often with a sequence of steps.
Writing a good guide requires thinking about what your users are trying to do.

## Further reading

- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ Commons contains the core classes and interfaces.
#### Dependencies
- [Commons](#commons)
### Backend [![repo](@assets/github.svg)](https://github.com/Selenite-GEOS/backend)
### Simplified Interface [![repo](@assets/github.svg)]()
MacroBlocs management.
### Simplified Interface [![repo](@assets/github.svg)](https://github.com/Selenite-GEOS/simplified-interface)
#### Dependencies
- [Commons](#commons)
- [Graph Editor](#graph-editor)
Expand Down
3 changes: 3 additions & 0 deletions src/content/docs/reference/backend-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Backend API
---
5 changes: 5 additions & 0 deletions src/content/docs/reference/commons-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Commons API
---

See https://selenite-geos.github.io/commons/modules.html for the full API documentation.
5 changes: 5 additions & 0 deletions src/content/docs/reference/graph-editor-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Graph Editor API
---

See https://selenite-geos.github.io/graph-editor/modules.html for the full API documentation.

0 comments on commit 701150c

Please sign in to comment.