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.

Sign up for GitHub

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

Jump to bottom

Reference autogenerated docs #63

Closed
skliper opened this issue Apr 1, 2020 · 5 comments · Fixed by #99 or #106
Closed

Reference autogenerated docs #63

skliper opened this issue Apr 1, 2020 · 5 comments · Fixed by #99 or #106
Assignees
@JandlynBentley-at-NASA
Labels
enhancement good first issue Good for newcomers

Comments

@skliper
Copy link
Contributor

skliper commented Apr 1, 2020

Is your feature request related to a problem? Please describe.
See #61
No current references to the generated documents

Describe the solution you'd like
Once the docs are deployed the first time (after push of #61 to master and CI completes) add references from at least README.md.

Describe alternatives you've considered
None

Additional context
None

Requester Info
Jacob Hageman - NASA/GSFC
@skliper skliper added the good first issue Good for newcomers label Apr 10, 2020
@skliper
Copy link
Contributor Author

skliper commented Apr 10, 2020

Just add references in README.md to the documents in the gh_pages branch.

@JandlynBentley-at-NASA
Copy link
Contributor

I'm looking for clarification (I'm new to cFS). Which references are you specifically referring to?

@skliper
Copy link
Contributor Author

skliper commented Jun 11, 2020

https://github.com/nasa/cFS/tree/gh-pages

@JandlynBentley-at-NASA
Copy link
Contributor

Apologies for not being more specific, I meant which references in the README should be added to the cFE and OSAL user guides in the gh pages branch?

@skliper
Copy link
Contributor Author

skliper commented Jun 12, 2020

I may not be understanding the question, but the request is to add references in the README.md to the user's guides. Just add a "References to auto-generated documentation" section, and links to the two files.

@JandlynBentley-at-NASA JandlynBentley-at-NASA linked a pull request Jun 12, 2020 that will close this issue
Fix #63, Added the references (links) to the cFE and OSAL user guides from the… #99
Merged
Merged
astrogeco pushed a commit that referenced this issue Jun 23, 2020
@JandlynBentley-at-NASA
Fix #63, Added the references (links) to the cFE and OSAL user guides…
e74a485 
… from the… (#99)

* Added the references (links) to the cFE and OSAL user guides from the gh-pages branch.

* Moved the references to the top of the document before release notes.
@astrogeco astrogeco mentioned this issue Jun 23, 2020
Merged
chillfig pushed a commit to chillfig/cFS that referenced this issue Mar 17, 2022
@jphickey
Fix nasa#63, remove macros within C code
cefc41e 
Reworks the CF_CmdGetSetParam to be clearer in its
implementation, not require the use of endian-specific
conditionally-compiled code.
chillfig pushed a commit to chillfig/cFS that referenced this issue Mar 17, 2022
@zanzaben
Merge pull request nasa#163 from jphickey/fix-63-macros-in-code
b614284 
Fix nasa#63, remove macros within C code
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JandlynBentley-at-NASA JandlynBentley-at-NASA

Labels
enhancement good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
2 participants
@skliper @JandlynBentley-at-NASA