Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/root' into root
Browse files Browse the repository at this point in the history
  • Loading branch information
weblate committed Oct 27, 2023
2 parents 37af270 + 93bad0a commit ad96290
Show file tree
Hide file tree
Showing 20 changed files with 273 additions and 0 deletions.
6 changes: 6 additions & 0 deletions Writerside/c.list
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE categories
SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
<categories>
<category id="wrs" name="Writerside documentation" order="1"/>
</categories>
12 changes: 12 additions & 0 deletions Writerside/cfg/buildprofiles.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<variables></variables>
<build-profile instance="kordex">
<variables>
<noindex-content>true</noindex-content>
</variables>
</build-profile>

</buildprofiles>
Binary file added Writerside/images/completion_procedure.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/completion_procedure_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/convert_table_to_xml.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/convert_table_to_xml_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/new_topic_options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Writerside/images/new_topic_options_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions Writerside/kordex.tree
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE instance-profile
SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">

<instance-profile id="kordex"
name="Kord Extensions"
start-page="Welcome.topic">

<toc-element topic="Welcome.topic"/>
<toc-element topic="About.topic">
</toc-element>
<toc-element topic="Core-Documentation.topic">
<toc-element topic="Getting-Started.md"/>
</toc-element>
<toc-element topic="Data-Adapters.topic"/>
<toc-element topic="Functional-Modules.topic">
</toc-element>
<toc-element topic="Utility-Modules.topic"/>
</instance-profile>
9 changes: 9 additions & 0 deletions Writerside/redirection-rules.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE rules SYSTEM "https://resources.jetbrains.com/writerside/1.0/redirection-rules.dtd">
<rules>
<!-- format is as follows
<rule id="<unique id>">
<accepts>page.html</accepts>
</rule>
-->
</rules>
70 changes: 70 additions & 0 deletions Writerside/topics/About.topic
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
id="About" title="About the Project">

<title>
About the Project
</title>

<tldr>
<p>
Latest version: <code>%version%</code>
</p>

<p>
Snapshots:
<a href="https://s01.oss.sonatype.org/content/repositories/snapshots">
Sonatype Snapshots (s01)
</a>
</p>

<p>
Coordinate:
<path>com.kotlindiscord.kord.extensions:kord-extensions</path>
</p>
</tldr>

<p>
Kord Extensions is a Discord bot framework built on top of
<a href="https://kord.dev">the excellent Kord library</a>.
It provides a framework for Discord bots of all sizes, with easy-to-use commands, rich argument parsing, and
many more useful features.
</p>

<p>
Kord Extensions takes a somewhat different approach when compared to other Kotlin-based Discord bot frameworks,
with inspiration taken from
<a href="https://docs.pycord.dev/en/stable/ext/commands/cogs.html">PyCord's Cogs feature</a> instead of a
light DSL meant for prototyping or implementing small bots.
However, regardless of this inspiration, Kord Extensions still provides an idiomatic API that makes full use of
Kotlin's niceties.
</p>

<tip>
<title>Why not other Kord-based frameworks?</title>

<p>
We built Kord Extensions from the ground up, prioritising the developer experience above all else, and we
believe it speaks for itself.
However, not every framework is right for every bot, so we've created a
<a href="https://docs.google.com/spreadsheets/d/e/2PACX-1vQtsks-QAnwoR0VmWgjTzq5T2QD66wNpEsWE_g5aZ6Z-nM6cJ3MpjIVF0m79j8of8huh4bIuxOIqz2-/pubhtm">
Framework Comparison Matrix
</a>.
This matrix includes all the major Kord-based frameworks, so be sure to inform yourself about them before
deciding on a specific framework.
</p>
</tip>

<seealso style="cards">
<category ref="components">
<a href="Core-Documentation.topic" summary="Kord Extensions core documentation"/>
<a href="Data-Adapters.topic" summary="First-party data adapters and how to use them"/>
<a href="Functional-Modules.topic"
summary="Information on first-party modules that provide extra functionality for your bots"/>
<a href="Utility-Modules.topic"
summary="Documentation on utility modules that provide extra development tools"/>
</category>
</seealso>
</topic>
9 changes: 9 additions & 0 deletions Writerside/topics/Core-Documentation.topic
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Core Documentation" id="Core-Documentation" help-id="Kord-Extensions-Core">

<p>Start typing here...</p>
</topic>
9 changes: 9 additions & 0 deletions Writerside/topics/Data-Adapters.topic
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Data Adapters" id="Data-Adapters">

<p>Start typing here...</p>
</topic>
9 changes: 9 additions & 0 deletions Writerside/topics/Functional-Modules.topic
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Functional Modules" id="Functional-Modules" help-id="Extra-Modules">

<p>Start typing here...</p>
</topic>
51 changes: 51 additions & 0 deletions Writerside/topics/Getting-Started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
switcher-label: Build System
---

# Getting Started

Start typing here...

## Dependencies

<tabs group="build-system">
<tab group-key="gradle-kotlin" title="Gradle (Kotlin)">
apple

apple
</tab>

<tab group-key="gradle-groovy" title="Gradle (Groovy)">
banana

banana
</tab>

<tab group-key="maven" title="Maven">
carrot

carrot
</tab>
</tabs>

## Project

<tabs group="build-system">
<tab group-key="gradle-kotlin" title="Gradle (Kotlin)">
apple

apple
</tab>

<tab group-key="gradle-groovy" title="Gradle (Groovy)">
banana

banana
</tab>

<tab group-key="maven" title="Maven">
carrot

carrot
</tab>
</tabs>
9 changes: 9 additions & 0 deletions Writerside/topics/Utility-Modules.topic
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Utility Modules" id="Utility-Modules">

<p>Start typing here...</p>
</topic>
55 changes: 55 additions & 0 deletions Writerside/topics/Welcome.topic
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Welcome" id="Welcome" help-id="Section-Starting-Page">

<section-starting-page>
<title>Welcome</title>

<description>
Kord Extensions is a Discord bot framework, with powerful (and easy-to-use) tooling and utilities for writing
Discord bots.
</description>

<primary>
<title>First Steps</title>
<a href="About.topic" type="learn" summary="General information about Kord Extensions" />
<a href="Getting-Started.md" type="development" summary="Jump into your first project right away" />
</primary>

<secondary>
<title>Topics</title>

<a href="Core-Documentation.topic" type="start"
summary="Everything that comes with Kord Extensions, and information about building and maintaining your Discord bots" />

<a href="Data-Adapters.topic" type="data"
summary="First-party data adapters, what they are, and how to use them" />

<a href="Functional-Modules.topic" type="mixed"
summary="First-party modules, which provide user-facing functionality for your bots" />

<a href="Utility-Modules.topic" type="library"
summary="Extra utility modules, which provide specific development tools and libraries" />
</secondary>

<misc>
<links>
<group>
<title>Relevant links</title>
<a href="https://github.com/Kord-Extensions/">Kord Extensions on GitHub</a>
<a href="https://github.com/Kord-Extensions/template">Template project</a>
</group>

<group>
<title>Other projects</title>
<a href="https://github.com/kordlib/kord">Kord on GitHub</a>
<a href="https://kord.dev">Kord documentation</a>
</group>
</links>
</misc>
</section-starting-page>

</topic>
6 changes: 6 additions & 0 deletions Writerside/v.list
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE vars SYSTEM "https://resources.jetbrains.com/writerside/1.0/vars.dtd">
<vars>
<var name="product" value="Kord Extensions" />
<var name="version" value="1.5.10-SNAPSHOT" />
</vars>
8 changes: 8 additions & 0 deletions Writerside/writerside.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/writerside/1.0/ihp.dtd">

<ihp version="2.0">
<topics dir="topics" web-path="topics"/>
<images dir="images" web-path="images"/>
<instance src="kordex.tree" web-path="/" version="%version%"/>
</ihp>
1 change: 1 addition & 0 deletions gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ kotlin.incremental = true

ksp.incremental = false

# Must be updated for Writerside in v.list
projectVersion = 1.5.10-SNAPSHOT

#dokka will run out of memory with the default meta space
Expand Down

0 comments on commit ad96290

Please sign in to comment.