Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #2542, improve app dev guide #2541

Merged
merged 1 commit into from
Apr 5, 2024
Merged

Fix #2542, improve app dev guide #2541

merged 1 commit into from
Apr 5, 2024

Conversation

cazlo
Copy link
Contributor

@cazlo cazlo commented Mar 30, 2024

Checklist (Please check before submitting)

Describe the contribution
Many documentation improvements for application user guide:

  • wrap several descriptions of functions in markdown code blocks to call them out as code
  • wrap hex values in markdown code to allow them to standout more easily
  • fix a few typos
  • fix a few grammatical errors
  • more consistently format markdown tables

Fixes #2542

Testing performed
Read rendered Docs in GitHub

Expected behavior changes
Documentation changes made in Docs render OK and don't change the original intent.

System(s) tested on

github.com/cazlo/CFE

Additional context
N/A

Third party code
N/A

Contributor Info - All information REQUIRED for consideration of pull request
Full name and company/organization/center of all contributors ("Personal" if individual work)

  • Andrew Paettie (Personal contributor)

@cazlo cazlo changed the title Fix #TBD, improve app dev guide Fix #2542, improve app dev guide Mar 30, 2024
- wrap several descriptions of functions in markdown code blocks to call them out as code
- wrap hex values in markdown code to allow them to standout more easily
- fix a few typos
- fix a few grammatical errors
- more consistently format markdown tables
@dzbaker dzbaker added the CCB:Approved Indicates code review and approval by community CCB label Apr 4, 2024
dzbaker added a commit to nasa/cFS that referenced this pull request Apr 5, 2024
*Combines:*

cFE equuleus-rc1+dev127

**Includes:**

*cFE*
- nasa/cFE#2541
- nasa/cFE#2544

Co-authored by: Drew Paettie <cazlo@users.noreply.github.com>
Co-authored by: Joseph Hickey <jphickey@users.noreply.github.com>
@dzbaker dzbaker merged commit 100acae into nasa:main Apr 5, 2024
21 of 22 checks passed
dzbaker added a commit to nasa/cFS that referenced this pull request Apr 5, 2024
*Combines:*

cFE equuleus-rc1+dev127

**Includes:**

*cFE*
- nasa/cFE#2541
- nasa/cFE#2544

Co-authored by: Drew Paettie <cazlo@users.noreply.github.com>
Co-authored by: Joseph Hickey <jphickey@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CCB:Approved Indicates code review and approval by community CCB
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve application developer guide documentation
3 participants