Skip to content

[Documentation] Write proper documentation for the Wiki #3

@OriDevTeam

Description

@OriDevTeam

Write an introduction that explains what is the project and why it was done, a guide explaining how loading works, a guide to how to use already existing shaping projects and a guide explaining how the process works

The introduction guide should be very friendly to users that already have notion of how text manipulation works

All sections should have an estimated time of reading, with the goal of reducing time necessary to read, and inform how much time estimate it should take to read

Follows the proposal of the table of contents:

Introduction

  • What is CodeShaper
  • Using CodeShaper
  • Using Shaping Projects

How it works

  • Loading
  • Processing
    • Visitors
    • Patches
    • Actions
  • Output

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationrequiredRequired feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions