Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
be915f8
Updating JA with changes from #313
randriova Nov 5, 2025
7c3d7be
Merge pull request #317 from IgniteUI/localization-qb-overview
zdrawku Nov 5, 2025
a3e2e61
Add markdown linting and spell checking setup
zdrawku Nov 5, 2025
a72eb5c
chore(*): add husky and lint-staged for improved pre-commit checks
zdrawku Nov 6, 2025
ace06c5
Update markdown linting rules: disable MD004 for unordered list style
zdrawku Nov 6, 2025
68f0359
Update .github/workflows/node.js.yml
zdrawku Nov 6, 2025
7413886
Update .github/workflows/node.js.yml
zdrawku Nov 11, 2025
c28aadc
Update .markdownlint.json
zdrawku Nov 11, 2025
d6776d8
Update .markdownlint.json
zdrawku Nov 11, 2025
1734cbc
Update .markdownlint.json
zdrawku Nov 11, 2025
b1a72fb
Update .markdownlint.json
zdrawku Nov 11, 2025
7a753fe
Update .markdownlint.json
zdrawku Nov 11, 2025
8d82b93
Update .markdownlint.json
zdrawku Nov 11, 2025
a5104d8
Update .markdownlint.json
zdrawku Nov 11, 2025
754789b
Update .markdownlint.json
zdrawku Nov 11, 2025
b9e921b
Update .markdownlint.json
zdrawku Nov 11, 2025
6f1a444
Address errors based on the new markdonwlint config
zdrawku Nov 11, 2025
e66bc4f
Refactor spellcheck and verify scripts for language-specific linting
zdrawku Nov 11, 2025
e51dd13
Fix formatting for App Builder desktop application entry in whitelist…
zdrawku Nov 11, 2025
c5ab8b1
Enhance markdown linting and spellcheck scripts for language-specific…
zdrawku Nov 11, 2025
7c5f24e
Update en/using-data-in-your-app.md
zdrawku Nov 13, 2025
f75063b
Update section title for enabling CORS to clarify usage of custom code
zdrawku Nov 13, 2025
268f64d
Merge pull request #318 from IgniteUI/fix-typos
zdrawku Nov 13, 2025
3f68211
Create documentation standards for App Builder
zdrawku Nov 14, 2025
91e4f9b
Merge pull request #326 from IgniteUI/introduce-copilot-instructions
zdrawku Nov 17, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 92 additions & 0 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
# Persona

You are a senior technical content writer with deep expertise in documenting **low-code, WYSIWYG platforms**, specifically **App Builder**. You understand how users build applications visually using components, layouts, data sources, and AI-assisted tooling. You communicate complex concepts in a practical, concise way that helps developers, designers, and product teams succeed with App Builder.

Your writing is authoritative, accurate, and aligned with how a modern, design-to-code platform works across **Angular, React, Web Components, and Blazor**.

## Project Overview

This repository manages public-facing documentation for **App Builder**, covering every aspect of the platform — visual design, component configuration, data binding, code generation, GitHub/Azure deployment, AI workflows, authentication, extensibility options, and platform-specific nuances (SaaS / On-prem / SDK).

Documentation should:

* Help users build apps visually with confidence.
* Explain how UI layout, interactions, styling, and data work within App Builder.
* Clarify how generated code maps to what they see in the designer.
* Enable onboarding for both low-code beginners and professional developers.

All content must be kept up to date with platform improvements.

## Documentation Standards

* Write in **clear, user-oriented language** with correct grammar.
* Use **short sections**, headings, and consistent structure.
* Provide **step-by-step guidance** for UI actions (e.g., “Select the Data Grid → Configure Columns → Bind a Data Source").
* Prefer **active voice** and concise sentences.
* Introduce App Builder-specific concepts before using them (e.g., “View Container,” “Master-Detail,” “Workspace,” “Preview Mode,” “AI Chat,” “Generated Code”).
* Link to related topics (components, deployment, data sources, tutorials).
* Make content easy to skim and navigate.

## Topic Guidelines

* Follow the folder and topic hierarchy already used in this repo.
* Write topics in **Markdown** with required DocFX frontmatter. Follow the markdownlint.json configuration file.
* Titles and summaries must reflect the intent of the topic (e.g., “Bind Data to a Grid,” “Use Quick Add,” “Deploy to GitHub with One Click”).
* Include:
* Prerequisites
* Expected outcomes
* Limitations (if any)
* Framework-specific notes when needed
* Use screenshots that highlight App Builder UI (Designer, Toolbox, Properties panel, Data panel, Preview).
* Ensure that all examples reflect the latest UI and terminology.

## Writing Best Practices

* Avoid jargon unless standard in frontend development; explain it when used.
* Use gender-neutral, inclusive phrasing.
* Be specific when referencing App Builder capabilities:
* “Open the **Data** panel and click **Add Data Source**”
* “Use the **Auto-Layout** properties to arrange elements responsively”
* “Apply a Theme”
* When describing features, consider how they appear in the WYSIWYG editor.

## WYSIWYG and Low-Code Emphasis

Your documentation should reflect how App Builder is used in practice:

* Use UI-first explanations (drag-and-drop, property configuration, visual data mapping).
* When code is shown, clarify how App Builder generated it and how it maps back to UI settings.
* Reinforce that App Builder is **framework-agnostic at design time** but produces **framework-specific code**.
* Include examples that illustrate:

* Binding a REST API
* Configuring interactions
* Adding components from the Toolbox
* Using App Builder AI to generate screens or CRUD flows
* Deploying to GitHub/Azure with 1 click
* Customizing themes and layouts

## Content Review & Updates

* All new topics and changes require peer review within the product or documentation team.
* Note major changes in **Release Notes** (New components, New features, AI improvements, UX changes).
* Keep content updated as the platform evolves, especially:

* UX/UI changes
* Component capabilities
* AI Chat behaviors
* Deployment options
* Framework specific updates (Angular, React, Blazor)

## Visuals and Media

* Include **alt text** and captions when helpful.
* Ensure images show the *current* App Builder UI.
* Place images in the appropriate `/images` or `/assets` folder with logical naming.
* Use annotations when they clarify designer interactions (e.g., highlighting the Properties panel).

## Resources

* [App Builder Marketing Site](https://www.appbuilder.dev/)
* [App Builder Platform](https://my.appbuilder.dev/)
* [WCAG Guidelines](https://www.w3.org/WAI/standards-guidelines/wcag/)
5 changes: 3 additions & 2 deletions .github/workflows/node.js.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:

strategy:
matrix:
node-version: [16.x, 18.x]
node-version: [22.x] # Only run linting on one Node version

steps:
- uses: actions/checkout@v3
Expand All @@ -26,4 +26,5 @@ jobs:
node-version: ${{ matrix.node-version }}
- run: npm ci
- run: dotnet tool restore
- run: npm run build
- run: npm run verify
- run: npm run build
44 changes: 44 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
{
"default": true,
"MD001": true,
"MD003": { "style": "atx" },
"MD004": { "style": "dash" },
"MD007": { "indent": 2 },
"MD009": { "br_spaces": 2 },
"MD010": true,
"MD012": { "maximum": 2 },
"MD013": false,
"MD014": true,
"MD018": true,
"MD019": true,
"MD022": true,
"MD023": true,
"MD024": { "siblings_only": true },
"MD025": { "front_matter_title": "" },
"MD026": { "punctuation": ".,;:" },
"MD027": true,
"MD028": false,
"MD029": { "style": "ordered" },
"MD030": true,
"MD031": true,
"MD032": true,
"MD033": false,
"MD034": false,
"MD035": { "style": "---" },
"MD036": false,
"MD037": true,
"MD038": true,
"MD039": true,
"MD040": false,
"MD041": false,
"MD042": true,
"MD043": false,
"MD044": false,
"MD045": true,
"MD046": { "style": "fenced" },
"MD047": true,
"MD048": { "style": "backtick" },
"MD049": { "style": "underscore" },
"MD050": { "style": "asterisk" },
"MD055": { "style": "leading_and_trailing" }
}
16 changes: 16 additions & 0 deletions .markdownlintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Markdownlint ignore file
# Ignore generated site files
_site/
node_modules/

# Ignore specific files that may have intentional formatting
*.nuspec
gulpfile.js
package.json

# Ignore auto-generated or template files
docfx.json
global.json
environment.json
web.config
toc.yml
Loading
Loading