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

[Docs] Harmonise README with docs. #55

Merged
merged 10 commits into from
Oct 10, 2023
Merged

[Docs] Harmonise README with docs. #55

merged 10 commits into from
Oct 10, 2023

Conversation

RolandMacDoland
Copy link
Collaborator

Closes #54

@RolandMacDoland RolandMacDoland self-assigned this Oct 9, 2023
@RolandMacDoland RolandMacDoland changed the title Harmonise README with docs. [Docs] Harmonise README with docs. Oct 9, 2023
@RolandMacDoland RolandMacDoland added the documentation Improvements or additions to documentation label Oct 9, 2023
@madagra
Copy link
Collaborator

madagra commented Oct 9, 2023

@Roland-djee you can use symlink to the index.md. Github supports the rendering differently than Gitlab.

@RolandMacDoland
Copy link
Collaborator Author

RolandMacDoland commented Oct 9, 2023

@Roland-djee you can use symlink to the index.md. Github supports the rendering differently than Gitlab.

Sure, but there is extra examples in the index that I don't feel necessary to add in the README. Conversely, we'll also want to add info in the README that doesn't sit in the docs.

@nmheim
Copy link
Collaborator

nmheim commented Oct 9, 2023

Once we have to docs build set up properly (working on it) we should update the links to .md files as well. They are not converted to working docs pages links because the README is not built via mkdocs.

README.md Outdated Show resolved Hide resolved
@RolandMacDoland
Copy link
Collaborator Author

@madagra Could you please have a quick look at this one ?

@madagra madagra merged commit 34c1adb into main Oct 10, 2023
@madagra madagra deleted the rg/fix-readme branch October 10, 2023 11:25
madagra added a commit that referenced this pull request Oct 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make README consistent with docs
4 participants