Skip to content

Commit d6bdfd4

Browse files
authored
Merge pull request #39 from Codeplain-ai/docs/grammatical-mistakes
Corrected Plain to ***plain spelling
2 parents 5d5e362 + 812ae20 commit d6bdfd4

3 files changed

Lines changed: 16 additions & 16 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Schematic overview of the Codeplain's code generation service
1717

1818
An example application in ***plain
1919

20-
<img src="resources/plain_example.png" width="50%" height="50%">
20+
<img src="resources/plain_example.png" width="70%" height="70%">
2121

2222

2323
## Getting started
@@ -87,7 +87,7 @@ After completing the installation steps above, you can immediately test the syst
8787
### Documentation
8888

8989
- For more details on the ***plain format, see the [***plain language specification](docs/plain_language_specification.md).
90-
- For step-by-step instructions for creating your first ***plain project see the [Kickstart your plain project](docs/starting_a_plain_project_from_scratch.md).
90+
- For step-by-step instructions for creating your first ***plain project see the [Kickstart your ***plain project](docs/starting_a_plain_project_from_scratch.md).
9191
- For complete CLI documentation and usage examples, see [plain2code CLI documentation](docs/plain2code_cli.md).
9292

9393

docs/plain_language_specification.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ Definitions are the mechanism for definining data structures in ***plain. Here's
115115

116116
The `***Non-Functional Requirements:***` specification is a list of instructions that steer software code implementation and provide details of execution environment.
117117

118-
Here's an example of a simple instruction specifying only that the Plain specification should be rendered to Python software code.
118+
Here's an example of a simple instruction specifying only that the ***plain specification should be rendered to Python software code.
119119

120120
```plain
121121
- :Implementation: should be in Python.
@@ -149,7 +149,7 @@ Each functional requirement must be limited in complexity. For example, for the
149149
- :App: should implement a task manager application.
150150
```
151151

152-
the renderer of Plain source to software code should respond with
152+
the renderer of ***plain source to software code should respond with
153153

154154
```
155155
Functional requirement too complex!
@@ -219,18 +219,18 @@ Lines starting with `>` are ignored when rendering software code.
219219

220220
## Template System
221221

222-
Plain supports template inclusion using the `{% include %}` syntax, which allows you to use predefined templates in your specifications.
222+
***plain supports template inclusion using the `{% include %}` syntax, which allows you to use predefined templates in your specifications.
223223

224224
```plain
225225
{% include "python-console-app-template.plain", main_executable_file_name: "my_app.py" %}
226226
```
227227
Predefined templates are available for Go console apps, Python console apps, and TypeScript React apps in the [standard template library](../standard_template_library/). You can also create your own custom templates.
228228

229-
The template system enables code reuse and standardization across Plain projects.
229+
The template system enables code reuse and standardization across ***plain projects.
230230

231231
## Linked Resources
232232

233-
If you include a link using the markdown syntax, the linked resource will be passed along with the Plain specification to the renderer.
233+
If you include a link using the markdown syntax, the linked resource will be passed along with the ***plain specification to the renderer.
234234

235235
Here's an example of a linked resource (see Task manager example application for the full specification).
236236

@@ -239,12 +239,12 @@ Here's an example of a linked resource (see Task manager example application for
239239
```
240240

241241
**Important Notes:**
242-
- Only links to files in the same folder (and its subfolders) as the Plain specification are supported. Links to external resources are not supported.
243-
- File paths are resolved relative to the location of the Plain specification file.
242+
- Only links to files in the same folder (and its subfolders) as the ***plain specification are supported. Links to external resources are not supported.
243+
- File paths are resolved relative to the location of the ***plain specification file.
244244
- All types are supported, except binary files.
245245

246246
## Liquid templates
247247

248-
Plain supports Liquid templates. Liquid is an open-source template language created by Shopify (https://shopify.github.io/liquid/).
248+
***plain supports Liquid templates. Liquid is an open-source template language created by Shopify (https://shopify.github.io/liquid/).
249249

250250
For a sample use of Liquid templates see [example-saas-connectors](https://github.com/Codeplain-ai/example-saas-connectors) repository.

docs/starting_a_plain_project_from_scratch.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# How to Start a New Plain Project from Scratch
1+
# How to Start a New ***plain Project from Scratch
22

3-
This guide will walk you through creating your first Plain project from scratch.
3+
This guide will walk you through creating your first ***plain project from scratch.
44
It assumes you have already:
55

66
✅ Met all [prerequisites](../README.md#prerequisites),
@@ -9,11 +9,11 @@ It assumes you have already:
99

1010
If you haven't done so yet, please refer to [README](../README.md).
1111

12-
After following this guide, you'll be equipped to turn your ideas into working code with Plain.
12+
After following this guide, you'll be equipped to turn your ideas into working code with ***plain.
1313

1414
## Project Structure Overview
1515

16-
Every Plain project follows this basic structure:
16+
Every ***plain project follows this basic structure:
1717

1818
```
1919
my-new-project/
@@ -29,7 +29,7 @@ In this guide we will cover how to create each of these step by step.
2929

3030
## 1. Define Your .plain File
3131

32-
Create a `.plain` file. The following example shows how to specify the array sorting problem. For more details, see [Plain language specifications](plain_language_specification.md).
32+
Create a `.plain` file. The following example shows how to specify the array sorting problem. For more details, see [***plain language specifications](plain_language_specification.md).
3333

3434
**Example: `array_sorting.plain`**
3535
```plain
@@ -74,7 +74,7 @@ conformance-tests-script: ./run_conformance_tests_python.sh
7474
verbose: true
7575

7676
```
77-
- Specify the test scripts so that Plain knows how to run unit and conformance tests.
77+
- Specify the test scripts so that ***plain knows how to run unit and conformance tests.
7878
- Indicate whether to display detailed output during code generation like shown in output control.
7979
- For additional options and advanced configuration, see the [plain2code CLI documentation](plain2code_cli.md).
8080

0 commit comments

Comments
 (0)