Updated readme with modern guidelines on how to build docs #51
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
StephenNneji
left a comment
StephenNneji
left a comment
There was a problem hiding this comment.
Thanks for the PR, please see comments below
StephenNneji
approved these changes
Aug 14, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the partial contribution to Ticket #50 and modifies readme.md to describe how to build RAT documentation.
It does not close the ticket but I beieve describes the way to build the documentation for the modern package.
I was not able to build doc following current vesion or
readme.mdwithout additional thinking and making assumptions, described in currentreadme.mdversion. Also current suggestion on location ofAPIfolder is confusing, so I had to read.gitignoreto understand itWhat is the new behaviour (if this is a feature change)?
I was able to build documentation following the description. Hope people would understand it better
Does this PR introduce a breaking change (What changes might users need to make in their application due to this PR)?
No