Started working on documentation

This commit is contained in:
2025-02-11 20:52:52 +01:00
parent 8db0f84a80
commit 47f30bf33f
31 changed files with 251 additions and 30 deletions

6
docs/Writerside/c.list Normal file
View File

@@ -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>

View File

@@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE buildprofiles SYSTEM "https://resources.jetbrains.com/writerside/1.0/build-profiles.dtd">
<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="hopframe">
<variables>
<noindex-content>false</noindex-content>
</variables>
</build-profile>
</buildprofiles>

View File

@@ -0,0 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE terms SYSTEM "https://resources.jetbrains.com/writerside/1.0/glossary.dtd">
<terms>
<term name="foo">
Description of what "foo" is.
</term>
</terms>

View File

@@ -0,0 +1,39 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE instance-profile
SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
<instance-profile id="hopframe"
name="HopFrame"
start-page="starter.md">
<toc-element topic="starter.md"/>
<toc-element topic="Installation.md"/>
<toc-element toc-title="Core Module">
<toc-element toc-title="Configurations">
<toc-element topic="HopFrameConfig.md"/>
<toc-element topic="DbContextConfig.md"/>
<toc-element topic="TableConfig.md"/>
<toc-element topic="PropertyConfig.md"/>
</toc-element>
<toc-element topic="Callbacks.md"/>
</toc-element>
<toc-element toc-title="Web Module">
<toc-element toc-title="Interface">
<toc-element topic="Table.md"/>
<toc-element topic="Dashboard.md"/>
</toc-element>
<toc-element topic="Plugins.md">
<toc-element topic="Events.md">
<toc-element topic="SelectEntityEvent.md"/>
<toc-element topic="UpdateEntityEvent.md"/>
<toc-element topic="CreateEntityEvent.md"/>
<toc-element topic="DeleteEntityEvent.md"/>
<toc-element topic="TableInitializedEvent.md"/>
<toc-element topic="PageChangeEvent.md"/>
<toc-element topic="ReloadEvent.md"/>
<toc-element topic="SearchEvent.md"/>
<toc-element topic="ValidationEvent.md"/>
</toc-element>
</toc-element>
</toc-element>
</instance-profile>

View File

@@ -0,0 +1,3 @@
# Callbacks
Start typing here...

View File

@@ -0,0 +1,3 @@
# CreateEntityEvent
Start typing here...

View File

@@ -0,0 +1,3 @@
# Dashboard
Start typing here...

View File

@@ -0,0 +1,3 @@
# DbContextConfig
Start typing here...

View File

@@ -0,0 +1,3 @@
# DeleteEntityEvent
Start typing here...

View File

@@ -0,0 +1,3 @@
# Events
Start typing here...

View File

@@ -0,0 +1,2 @@
# HopFrameConfig

View File

@@ -0,0 +1,31 @@
# Installation
Install the nuget package using the CLI or the UI of your IDE:
```bash
dotnet add package HopFrame.Web
```
## Minimal configuration
Configuring HopFrame is straightforward and flexible. You can easily define your contexts, tables, and their properties using the provided configurators.
Simply use your editors intelli-sense to find out what you can configure.
```c#
builder.Services.AddHopFrame(options => {
options.AddDbContext<DatabaseContext>();
});
```
Then you need to map the frontend pages in your application:
```c#
app.MapHopFrame();
```
## Usage
- Navigate to `/admin` to access the admin dashboard and start managing your tables.
- Use the side menu to switch between different tables.
- Utilize the built-in CRUD functionality to manage your data seamlessly.

View File

@@ -0,0 +1,3 @@
# PageChangeEvent
Start typing here...

View File

@@ -0,0 +1,3 @@
# Plugins
Start typing here...

View File

@@ -0,0 +1,3 @@
# PropertyConfig
Start typing here...

View File

@@ -0,0 +1,3 @@
# ReloadEvent
Start typing here...

View File

@@ -0,0 +1,3 @@
# SearchEvent
Start typing here...

View File

@@ -0,0 +1,3 @@
# SelectEntityEvent
Start typing here...

View File

@@ -0,0 +1,3 @@
# Table
Start typing here...

View File

@@ -0,0 +1,3 @@
# TableConfig
Start typing here...

View File

@@ -0,0 +1,3 @@
# TableInitializedEvent
Start typing here...

View File

@@ -0,0 +1,3 @@
# UpdateEntityEvent
Start typing here...

View File

@@ -0,0 +1,3 @@
# ValidationEvent
Start typing here...

View File

@@ -0,0 +1,14 @@
# Overview
Welcome to the HopFrame! This project aims to provide a comprehensive and modular framework for easy management of your database.
The framework is designed to be highly configurable, ensuring that developers either quickly add the framework for simple data editing or
configure it to their needs to implement it fully in their data management pipeline.
## Features
- **Dynamic Table Management**: Create, edit, and delete records dynamically with support for various data types including numeric, text, boolean, dates, and relational data.
- **Role-Based Access Control (RBAC)**: Implement fine-grained access control policies for viewing, creating, updating, and deleting records.
- **Modern Design**: A modern and user-friendly interface built with Fluent UI components, ensuring easy to use and pleasing administration pages.
- **Validation and Error Handling**: Comprehensive input validation and error handling to ensure data integrity and provide feedback to users.
- **Support for Complex Data Relationships**: Manage complex relationships between data entities with ease.

5
docs/Writerside/v.list Normal file
View File

@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE vars SYSTEM "https://resources.jetbrains.com/writerside/1.0/vars.dtd">
<vars>
<var name="product" value="Writerside"/>
</vars>

View File

@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/writerside/1.0/ihp.dtd">
<ihp version="2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/writerside-cfg.xsd">
<topics dir="topics"/>
<images dir="images" web-path="images"/>
<categories src="c.list"/>
<vars src="v.list"/>
<instance src="hopframe.tree" version="3.2.0"/>
</ihp>