Differential D3206

Update and add documentation
ClosedPublic
Actions

Authored by ieli on Jun 22 2023, 20:25.

Details

Reviewers

dereckson

Maniphest Tasks

T1909: Write ServPulse frontend documentation

Commits

rSP0467429ddf04: Remove prompt symbol from command
rSP4c9062f0f621: Update and add documentation

Summary

Add the frontend's background for memory aid purposes,
and reorganized important docs in the /docs/ folder

Diff Detail

Repository

rSP ServPulse

Lint

Lint Passed

Unit

No Test Coverage

Branch

docs/update-readme

Build Status

Buildable 5071
Build 5352: arc lint + arc unit

Event Timeline

ieli requested review of this revision.Jun 22 2023, 20:25

ieli created this revision.

Harbormaster completed remote builds in B5044: Diff 8201.Jun 22 2023, 20:25

ieli added a task: T1909: Write ServPulse frontend documentation.Jun 23 2023, 01:33

dereckson added inline comments.Jun 30 2023, 21:15

frontend/servpulse-frontend/docs/dev_starter.md
3	By MarkDown convention, backticks enclose directly the command, not the command line with the prompt.

Remove prompt symbol from command

Following Markdown convention, the prompt symbol should always be removed from the command to run.

Harbormaster completed remote builds in B5071: Diff 8242.Jun 30 2023, 23:26

ieli marked an inline comment as done.Jun 30 2023, 23:30

dereckson accepted this revision.Jul 1 2023, 19:03

This revision is now accepted and ready to land.Jul 1 2023, 19:03

Closed by commit rSP4c9062f0f621: Update and add documentation (authored by ieli). · Explain WhyJul 17 2023, 23:13

This revision was automatically updated to reflect the committed changes.

ieli added a commit: rSP4c9062f0f621: Update and add documentation.

ieli added a commit: rSP0467429ddf04: Remove prompt symbol from command.

Revision Contents
Changeset List

Path

Size

frontend/

servpulse-frontend/

docs/

dev_starter.md

2 lines

Diff 8242

View Options

frontend/servpulse-frontend/docs/dev_starter.md

Update and add documentationClosedPublicActions