Skip to content

Standardize all open source app READMEs to consistent format#88

Merged
basprintvis merged 1 commit intomainfrom
copilot/update-readme-files
Apr 27, 2026
Merged

Standardize all open source app READMEs to consistent format#88
basprintvis merged 1 commit intomainfrom
copilot/update-readme-files

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 27, 2026

All app READMEs were inconsistently formatted, incompletely documented, or missing entirely. This PR reformats every app README to match the JobTicket Split Signatures template structure and fills in content derived from the source code.

Changes

Reformatted in-place (existing README.md)

  • AvoidSameSorting, AutoLockMilestone, BuildSignatures, FilterOrderOnly, JobTicketCommentsRichText, Planning Board - ToolTip Performance, RollJobItem — restructured to standard sections, added ## How it works numbered logic walkthrough, corrected stale object numbers (e.g. BuildSignatures had codeunit 88200/pageext 80200 in docs vs actual 80198/80198)
  • Copy with Lookup — minor fix: removed bold from **Step N** markers to match template style

Renamed + reformatted (non-standard casing → README.md)

readme.md / ReadMe.md / Readme.md deleted and replaced with properly cased README.md for: AddSchedulingProblem, Copy Price Method, PrintVis FG Valuation PTE, ReleaseFinishedGoodsShowJobItems, Sales Order Integration, ShopFloorPreventCompleteWithoutConsumption, Split by Versions, SplitProduction, Status Code Lookup - filtered by Case Type

Created new README.md

  • CIM Migration To PTE — documented the 3-part migration process from the existing How To Use.md content
  • CIM Move Controller and Device Data to PrintVis — documented the 8-step upgrade process from CIM Upgrade Instructions.md
  • Sync — fully documented from source; covers table/page/codeunit inventory, sync log pipeline, OAuth 2.0 support, and setup steps

Template structure applied to all apps

# Title
Description paragraph

## What this extension includes
## How it works        ← numbered steps from event subscriber logic
## How to configure    ← Step N (no bold) format
## Prerequisites to run the functionality
## What you will need to do for this extension to work

Sections omitted where not applicable (e.g. single-subscriber apps with no configuration needed).

@basprintvis basprintvis marked this pull request as ready for review April 27, 2026 18:00
@basprintvis basprintvis requested a review from a team as a code owner April 27, 2026 18:00
@basprintvis basprintvis merged commit 211e489 into main Apr 27, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants