Upstream/waveterm
1
0
Fork 0
mirror of https://github.com/wavetermdev/waveterm.git synced 2024-12-21 16:38:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

minor docs fixups (consistency) (#1480)

Browse Source
This commit is contained in:
Mike Sawka 2024-12-10 18:03:48 -08:00 committed by GitHub
parent 7c76a438b2
commit 4fccd71227
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 87 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
cmd/packfiles/main-packfiles.go Normal file
View File

@ -0,0 +1,81 @@
package main
import (
"bufio"
"fmt"
"io"
"os"
"path/filepath"
)
func main() {
// Ensure at least one argument is provided
if len(os.Args) < 2 {
fmt.Fprintln(os.Stderr, "Usage: go run main.go <file1> <file2> ...")
os.Exit(1)
}
// Get the current working directory
cwd, err := os.Getwd()
if err != nil {
fmt.Fprintf(os.Stderr, "Error getting current working directory: %v\n", err)
os.Exit(1)
}
for _, filePath := range os.Args[1:] {
if filePath == "" || filePath == "--" {
continue
}
// Convert file path to an absolute path
absPath, err := filepath.Abs(filePath)
if err != nil {
fmt.Fprintf(os.Stderr, "Error resolving absolute path for %q: %v\n", filePath, err)
continue
}
finfo, err := os.Stat(absPath)
if err != nil {
fmt.Fprintf(os.Stderr, "Error getting file info for %q: %v\n", absPath, err)
continue
}
if finfo.IsDir() {
fmt.Fprintf(os.Stderr, "%q is a directory, skipping\n", absPath)
continue
}
// Get the path relative to the current working directory
relPath, err := filepath.Rel(cwd, absPath)
if err != nil {
fmt.Fprintf(os.Stderr, "Error resolving relative path for %q: %v\n", absPath, err)
continue
}
// Open the file
file, err := os.Open(absPath)
if err != nil {
fmt.Fprintf(os.Stderr, "Error opening file %q: %v\n", absPath, err)
continue
}
defer file.Close()
// Print start delimiter with quoted relative path
fmt.Printf("@@@start file %q\n", relPath)
// Copy file contents to stdout
reader := bufio.NewReader(file)
for {
line, err := reader.ReadString('\n')
fmt.Print(line) // Print each line
if err == io.EOF {
break
}
if err != nil {
fmt.Fprintf(os.Stderr, "Error reading file %q: %v\n", relPath, err)
break
}
}
// Print end delimiter with quoted relative path
fmt.Printf("@@@end file %q\n", relPath)
}
}

5
docs/docs/config.mdx
View File

@ -28,7 +28,7 @@ wsh editconfig
| ai:preset | string | the default AI preset to use | | ai:preset | string | the default AI preset to use |
| ai:baseurl | string | Set the AI Base Url (must be OpenAI compatible) | | ai:baseurl | string | Set the AI Base Url (must be OpenAI compatible) |
| ai:apitoken | string | your AI api token | | ai:apitoken | string | your AI api token |
| ai:apitype | string | defaults to "open_ai", but can also set to "azure" (forspecial Azure AI handling) or "anthropic" | | ai:apitype | string | defaults to "open_ai", but can also set to "azure" (forspecial Azure AI handling), "anthropic", or "perplexity" |
| ai:name | string | string to display in the Wave AI block header | | ai:name | string | string to display in the Wave AI block header |
| ai:model | string | model name to pass to API | | ai:model | string | model name to pass to API |
| ai:apiversion | string | for Azure AI only (when apitype is "azure", this will default to "2023-05-15") | | ai:apiversion | string | for Azure AI only (when apitype is "azure", this will default to "2023-05-15") |
@ -44,7 +44,7 @@ wsh editconfig
| term:copyonselect | bool | set to false to disable terminal copy-on-select | | term:copyonselect | bool | set to false to disable terminal copy-on-select |
| term:scrollback | int | size of terminal scrollback buffer, max is 10000 | | term:scrollback | int | size of terminal scrollback buffer, max is 10000 |
| editor:minimapenabled | bool | set to false to disable editor minimap | | editor:minimapenabled | bool | set to false to disable editor minimap |
| editor:stickscrollenabled | bool | | | editor:stickyscrollenabled | bool | enables monaco editor's stickyScroll feature (pinning headers of current context, e.g. class names, method names, etc.), defaults to false |
| editor:wordwrap | bool | set to true to enable word wrapping in the editor (defaults to false) | | editor:wordwrap | bool | set to true to enable word wrapping in the editor (defaults to false) |
| web:openlinksinternally | bool | set to false to open web links in external browser | | web:openlinksinternally | bool | set to false to open web links in external browser |
| web:defaulturl | string | default web page to open in the web widget when no url is provided (homepage) | | web:defaulturl | string | default web page to open in the web widget when no url is provided (homepage) |
@ -66,6 +66,7 @@ wsh editconfig
| window:magnifiedblocksize | float64 | change the size of a magnified block as a percentage of the dimensions of its parent layout (must be between 0 and 1, defaults to 0.9) | | window:magnifiedblocksize | float64 | change the size of a magnified block as a percentage of the dimensions of its parent layout (must be between 0 and 1, defaults to 0.9) |
| window:magnifiedblockblurprimarypx | int | change the blur in CSS pixels that is applied directly behind a magnified block (see [backdrop-filter](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter) for more info on how this gets applied) | | window:magnifiedblockblurprimarypx | int | change the blur in CSS pixels that is applied directly behind a magnified block (see [backdrop-filter](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter) for more info on how this gets applied) |
| window:magnifiedblockblursecondarypx | int | change the blur in CSS pixels that is applied to the visible portions of non-magnified blocks when a block is magnified (see [backdrop-filter](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter) for more info on how this gets applied) | | window:magnifiedblockblursecondarypx | int | change the blur in CSS pixels that is applied to the visible portions of non-magnified blocks when a block is magnified (see [backdrop-filter](https://developer.mozilla.org/en-US/docs/Web/CSS/backdrop-filter) for more info on how this gets applied) |
| window:maxtabcachesize | int | number of tabs to cache. when tabs are cached, switching between them is very fast. (defaults to 10) |
| window:showmenubar | bool | set to use the OS-native menu bar (Windows and Linux only, requires app restart) | | window:showmenubar | bool | set to use the OS-native menu bar (Windows and Linux only, requires app restart) |
| window:nativetitlebar | bool | set to use the OS-native title bar, rather than the overlay (Windows and Linux only, requires app restart) | | window:nativetitlebar | bool | set to use the OS-native title bar, rather than the overlay (Windows and Linux only, requires app restart) |
| window:disablehardwareacceleration | bool | set to disable Chromium hardware acceleration to resolve graphical bugs (requires app restart) | | window:disablehardwareacceleration | bool | set to disable Chromium hardware acceleration to resolve graphical bugs (requires app restart) |

2
docs/docs/customwidgets.mdx
View File

@ -52,7 +52,7 @@ This `WidgetConfigType` is shared between all types of widgets. That is to say,
**Font Awesome Icons** **Font Awesome Icons**
[Font Awesome](https://fontawesome.com/search) provides a ton of useful icons that you can use as a widget icon in your app. At it's simplest, you can just provide the icon name and it will be used. For example, the string `"house"`, will provide an icon containing a house. We also allow you to apply a few different styles to your icon by modifying the name as follows: [Font Awesome](https://fontawesome.com/search) provides a ton of useful icons that you can use as a widget icon in your app. At its simplest, you can just provide the icon name and it will be used. For example, the string `"house"`, will provide an icon containing a house. We also allow you to apply a few different styles to your icon by modifying the name as follows:
| format | description | | format | description |
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

8
docs/docs/features/_category_.json
View File

@ -1,8 +0,0 @@
{
"label": "Features",
"position": 2,
"link": {
"type": "generated-index",
"description": "Overview of Wave Terminal Features"
}
}

3
docs/docs/features/ai.mdx
View File

@ -1,3 +0,0 @@
# Wave AI
TODO: Add content

3
docs/docs/features/browser.mdx
View File

@ -1,3 +0,0 @@
# Inline Web Browser
TODO: Add content

3
docs/docs/features/charts.mdx
View File

@ -1,3 +0,0 @@
# Data Visualization
TODO: Add content

3
docs/docs/features/preview.mdx
View File

@ -1,3 +0,0 @@
# Preview
TODO: Add content

3
docs/docs/features/remotes.mdx
View File

@ -1,3 +0,0 @@
# Remote Connections
TODO: Add content

4
frontend/app/tab/tabbar.tsx
View File

@ -5,7 +5,7 @@ import { Button } from "@/app/element/button";
import { modalsModel } from "@/app/store/modalmodel"; import { modalsModel } from "@/app/store/modalmodel";
import { WindowDrag } from "@/element/windowdrag"; import { WindowDrag } from "@/element/windowdrag";
import { deleteLayoutModelForTab } from "@/layout/index"; import { deleteLayoutModelForTab } from "@/layout/index";
import { atoms, createTab, getApi, globalStore, PLATFORM, setActiveTab } from "@/store/global"; import { atoms, createTab, getApi, globalStore, isDev, PLATFORM, setActiveTab } from "@/store/global";
import { fireAndForget } from "@/util/util"; import { fireAndForget } from "@/util/util";
import { useAtomValue } from "jotai"; import { useAtomValue } from "jotai";
import { OverlayScrollbars } from "overlayscrollbars"; import { OverlayScrollbars } from "overlayscrollbars";
@ -637,7 +637,7 @@ const TabBar = memo(({ workspace }: TabBarProps) => {
} }
const tabsWrapperWidth = tabIds.length * tabWidthRef.current; const tabsWrapperWidth = tabIds.length * tabWidthRef.current;
const devLabel = false ? ( const devLabel = isDev() ? (
<div ref={devLabelRef} className="dev-label"> <div ref={devLabelRef} className="dev-label">
<i className="fa fa-brands fa-dev fa-fw" /> <i className="fa fa-brands fa-dev fa-fw" />
</div> </div>