Skip to content

Commit

Permalink
Start pages for main projects and modules
Browse files Browse the repository at this point in the history
  • Loading branch information
eliot-akira committed Jan 25, 2025
1 parent 3058157 commit 95ba19c
Show file tree
Hide file tree
Showing 19 changed files with 191 additions and 81 deletions.
26 changes: 0 additions & 26 deletions docs/pages/documentation.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/pages/guides/github-pages.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Set up a static site on GitHub Pages
# Static site on GitHub Pages

- [GitHub Pages documentation](https://docs.github.com/en/pages)
- [Configuring a custom domain for your GitHub Pages site](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site)
28 changes: 28 additions & 0 deletions docs/pages/guides/types-of-documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Types of documentation

Documentation can be organized by conceptual areas based on user needs. These are informed by [the Diátaxis system](https://diataxis.fr/).

## Types of documentation

- Practice
- Tutorials - Learning
- How-to guides - Tasks
- Theory
- Reference - Information
- Explanation - Understanding

### Tutorials

*A tutorial is a practical activity, in which the student learns by doing something meaningful, towards some achievable goal.*

### Guides

*A how-to guide helps the user get something done, correctly and safely; it guides the user’s action.*

### Reference

*Reference material contains theoretical knowledge that a user looks to in their work.*

### Explanation

*Explanation deepens the reader’s understanding of a subject. It brings clarity and context.*
3 changes: 3 additions & 0 deletions docs/pages/modules/create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Create

Repository: https://github.com/tangibleinc/create
3 changes: 3 additions & 0 deletions docs/pages/modules/fields.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Fields

Repository: https://github.com/tangibleinc/fields
2 changes: 2 additions & 0 deletions docs/pages/modules/framework.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Framework

Repository: https://github.com/tangibleinc/framework
3 changes: 3 additions & 0 deletions docs/pages/modules/pipeline.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Pipeline

Repository: https://github.com/tangibleinc/pipeline
3 changes: 3 additions & 0 deletions docs/pages/modules/roller.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Roller

Repository: https://github.com/tangibleinc/roller
5 changes: 5 additions & 0 deletions docs/pages/modules/update-server.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Update server

> Self-hosted update server for WordPress plugins and themes
Repository: https://github.com/tangibleinc/update-server
2 changes: 2 additions & 0 deletions docs/pages/modules/updater.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Updater

Repository: https://github.com/tangibleinc/updater
47 changes: 40 additions & 7 deletions docs/pages/projects/blocks.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,51 @@
---
title: Blocks
---
# Tangible Blocks

Tangible Blocks is a system for creating universal dynamic content blocks with HTML-based templates and Sass styling language. It can be integrated with site builders (Gutenberg, Elementor, Beaver Builder) as well as React applications.
Tangible Blocks is a system for creating universal dynamic content blocks with HTML-based templates and Sass styling language. It can be integrated with WordPress site and page builders, as well as React applications.


## Plugins

The project consists of a set of plugins.

- [Tangible Blocks](https://github.com/tangibleinc/blocks)
- [Blocks Editor](https://github.com/tangibleinc/blocks-editor) - Enable block template editing in the admin
- [Blocks Pro](https://github.com/tangibleinc/blocks-pro) - Third-party integrations such as WooCommerce
- [Loops & Logic](https://github.com/tangibleinc/loops) - Basic variant with all template types except blocks
- [L&L Pro](https://github.com/tangibleinc/loops-pro)
- [Tangible Blocks Editor](https://github.com/tangibleinc/blocks-editor) - Enable block template editing in the admin
- [Tangible Blocks Pro](https://github.com/tangibleinc/blocks-pro)
- [Loops & Logic](https://github.com/tangibleinc/loops) - Basic variant with all template types except blocks. Published in the official plugin directory on `wp.org`.
- [Loops & Logic Pro](https://github.com/tangibleinc/loops-pro)

And shared modules.
## Themes

- [Template System](https://github.com/tangibleinc/template-system) - Template parser, renderer, language definition (dynamic tags), frontend modules (JS & CSS), admin features
- [Tangible Blocks Theme](https://github.com/tangibleinc/blocks-theme)

## Modules

Modules are common features shared by plugins.

- [BetterDash](https://github.com/tangibleinc/betterdash-module) - Utilities for LearnDash
- [BetterLifter](https://github.com/tangibleinc/betterlifter-module) - Utilities for LifterLMS
- [Fields](https://github.com/tangibleinc/fields) - React-based form fields library
- [Fields Pro](https://github.com/tangibleinc/fields-pro)
- [Framework](https://github.com/tangibleinc/framework) - Commonly used features like logging, date formatting
- [Template System](https://github.com/tangibleinc/template-system) - Template parser, renderer, language definition (dynamic tags), frontend modules (JS & CSS), admin features
- [Template System Pro](https://github.com/tangibleinc/template-system-pro)
- [Updater](https://github.com/tangibleinc/updater) - Provide plugin updates from self-hosted [update server](https://github.com/tangibleinc/update-server)

## Third-party plugins

Blocks and L&L integrate with the following third-party plugins.

- Advanced Custom Fields
- Beaver Builder
- Elementor

The Pro variants add support for more.

- Easy Digital Downloads
- Gravity Forms
- LearnDash
- LifterLMS
- The Events Calendar
- WooCommerce
5 changes: 5 additions & 0 deletions docs/pages/projects/design.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Design

Website: https://design.tangible.one

Repository: https://github.com/tangibleinc/design
5 changes: 5 additions & 0 deletions docs/pages/projects/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Docs

Website: https://docs.tangible.one

Repository: https://github.com/tangibleinc/docs
4 changes: 4 additions & 0 deletions docs/pages/server/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
sidebar_position: 0
---
# Overview
9 changes: 5 additions & 4 deletions docs/pages/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,19 @@ Here is an example of a local development setup.

- Laptop with at least 16GB memory
- Operating system: Linux, macOS, or Windows Subsystem for Linux (WSL)
- Browser: [Firefox](https://www.mozilla.org/en-US/firefox/new/), Safari, or Chrome
- Editor: [Visual Studio Code](https://code.visualstudio.com/) with buit-in terminal
- Browser: [Firefox](https://www.mozilla.org/en-US/firefox/new/), Safari, Chrome/Chromium
- Editor: [Visual Studio Code](https://code.visualstudio.com/) with built-in terminal

## Prepare

The following software is required for the projects in the documentation.

- [Node](https://nodejs.org) - JavaScript runtime (version 20 and above) or [Bun](https://bun.sh/)
- [Node](https://nodejs.org) - JavaScript runtime (version 20 and above)
- [Git](https://git-scm.com/) - Version control system

Optionally, some tasks may depend on:
Optionally, some projects or tasks may depend on:

- [POSIX](https://en.wikipedia.org/wiki/List_of_POSIX_commands) (Portable Operating System Interface) commands
- [Bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell)) compatible shell
- [Docker Engine](https://docs.docker.com/engine/) for containerization
- [Bun](https://bun.sh/)
21 changes: 18 additions & 3 deletions docs/pages/wordpress/plugin.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Plugin

Here are some common folders and files for a WordPress plugin.
Here are common folders and files for a WordPress plugin.

## Documentation

Expand Down Expand Up @@ -55,7 +55,9 @@ Folder structure is `namespace/project`.

### `package.json`

Package configuration for NPM (Node package manager), Includes scripts to run and list of dependencies.
Package configuration for NPM (Node package manager). Defines a list of dependencies, and scripts you can run with `npm run`.

See [the Roller](/modules/roller) which bundles assets like JavaScript and CSS. For local development and testing, a tool called [Now](/modules/now) serves a self-contained site based on WordPress Playground.

### `tangible.config.js`

Expand Down Expand Up @@ -90,4 +92,17 @@ Language-specific preferences can be declared here.

### `.github`

GitHub Actions pipeline to test, build, and deploy the project.
GitHub Actions pipeline to test, build, and deploy the project. See [the Pipeline module](/modules/pipeline).

### `.prettierrc`

Formatter configuration for [Prettier](https://prettier.io/).

```json
{
"semi": false,
"singleQuote": true,
"tabWidth": 2,
"useTabs": false
}
```
11 changes: 9 additions & 2 deletions docs/pages/wordpress/theme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Theme

WordPress requires a theme to have a file named `style.css` with a comment block as header.
## Folders and files

A themes shared many of the same common folders and files as a plugin.

At the minimum, WordPress requires a theme to have a file named `style.css` with a comment block as header.

```css
/*
Expand Down Expand Up @@ -29,4 +33,7 @@ Template: parent-theme
```


See the [documentation for supported header fields](https://developer.wordpress.org/themes/core-concepts/main-stylesheet/#header-fields).
Here is [the entire list of supported header fields](https://developer.wordpress.org/themes/core-concepts/main-stylesheet/#header-fields).

- [WordPress Theme Handbook](https://developer.wordpress.org/themes)
- [Empty Block Theme](https://github.com/TangibleInc/empty-block-theme)
91 changes: 54 additions & 37 deletions docs/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,54 @@ const sidebars: SidebarsConfig = {
},
],
},

{
type: 'html',
value: `<hr>`,
// `<hr><div class="sidebar-section-title">Modules</div>`,
},
{
type: 'category',
label: 'Projects',
collapsed: false,
// collapsible: false,
items: [
{ type: 'autogenerated', dirName: 'projects' },
// {
// type: 'doc',
// id: 'projects/blocks',
// label: 'Blocks',
// },
],
},
{
type: 'category',
label: 'Modules',
collapsed: false,
// collapsible: false,
items: [
{ type: 'autogenerated', dirName: 'modules' },
// {
// type: 'doc',
// id: 'modules/framework',
// },
// {
// type: 'doc',
// id: 'modules/pipeline',
// },
// {
// type: 'doc',
// id: 'modules/updater',
// },
],
},
{
type: 'html',
value:
`<hr>`,
// `<hr><div class="sidebar-section-title">Server</div>`,
},

// {
// type: 'doc',
// id: 'server',
Expand Down Expand Up @@ -88,52 +136,21 @@ const sidebars: SidebarsConfig = {
},
{
type: 'html',
value: `<hr>`,
// `<hr><div class="sidebar-section-title">Modules</div>`,
},
{
type: 'category',
label: 'Projects',
collapsed: false,
// collapsible: false,
items: [
{
type: 'doc',
id: 'projects/blocks',
label: 'Blocks',
},
],
value:
`<hr>`,
// `<hr><div class="sidebar-section-title">Guides</div>`,
},
{
type: 'category',
label: 'Modules',
label: 'Guides',
collapsed: false,
// collapsible: false,
items: [
{
type: 'doc',
id: 'modules/framework',
},
{
type: 'doc',
id: 'modules/updater',
id: 'guides/types-of-documentation',
label: 'Types of documentation'
},
],
},
{
type: 'doc',
id: 'documentation',
},
{
type: 'html',
value: `<hr>` // `<hr><div class="sidebar-section-title">Guides</div>`,
},
{
type: 'category',
label: 'Guides',
collapsed: false,
// collapsible: false,
items: [
{
type: 'doc',
id: 'guides/github-pages',
Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type {Config} from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';
import {themes as prismThemes} from 'prism-react-renderer';

const title = 'Documentation'
const title = 'Tangible Docs'

// https://docusaurus.io/docs/next/api/themes/configuration
const config: Config = {
Expand Down

0 comments on commit 95ba19c

Please sign in to comment.