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

[Bug]: Ensure the readme file shows as the project overview content on the documentation site #477

Closed
1 task done
danuw opened this issue Feb 27, 2024 · 0 comments · Fixed by #485
Closed
1 task done
Assignees
Labels
bug Something isn't working

Comments

@danuw
Copy link
Collaborator

danuw commented Feb 27, 2024

Contact Details

No response

What happened?

Documentation site is based on the information that was in the docs folder.
Now it is published as a website, it does not surface the documentation from the root of the repo such as readme, contributing etc...
While we were ok that some of the repo specific docs about processes not necessarily surface on the documentation website, the readme file should be the "home page" for the docs as it really nicely sets the scene for the SDK

As a result, I will update the workflow that publishes the documentation to also move the readme file to the relevant place at deployment.

client

WebAPI (Default)

Relevant log output

N/A

Code of Conduct

  • I agree to follow this project's Code of Conduct
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: Done
1 participant