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

Installation, Quickstart Guide and Sphynx Overhaul #1259

Merged
merged 111 commits into from
Sep 6, 2022

Conversation

armleo
Copy link
Contributor

@armleo armleo commented Aug 10, 2022

  • Documentation changed, README no longer documentation's landing page
  • New installation and quickstart guides created

@armleo armleo marked this pull request as ready for review August 10, 2022 14:03
@armleo
Copy link
Contributor Author

armleo commented Aug 16, 2022

@vijayank88 Did you test the changes in the RTD? Why change warnings to warnings. They are not as eye catching as the red message. Maybe we can make it more eye catching by making changes to CSS instead?

@vijayank88
Copy link
Collaborator

vijayank88 commented Aug 16, 2022

@armleo
note warning should be highlighted from regular format. So user care about information given. In readthedocs its highlight properly, but in browser i see as normal font.

So highlight someway unique to view both the end.

I fixed the broken links of .html to .md. Is that correct or point the right source files?

I didn't fully completed readthedocs.io review. Only quickstart and installation docs reviewed.

@armleo
Copy link
Contributor Author

armleo commented Aug 16, 2022

note warning should be highlighted from regular format.

That is correct. But the docs are not supposed to be viewed with GitHub UI. All of the docs will migrate to .rst + RTD. RST is not supported properly by GitHub.

Everything else is fine.

@armleo
Copy link
Contributor Author

armleo commented Aug 18, 2022

Ready for merge once CI passes.

@donn donn changed the title Documentation overhaul. Primary pages only. Installation, Quickstart Guide and Sphynx Overhaul Sep 6, 2022
@donn donn self-requested a review September 6, 2022 09:51
Copy link
Collaborator

@donn donn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to do some copywriting, but otherwise, pretty good. I do expect the remaining markdown files in docs/ to be converted to rst as well, eventually.

@vijayank88
Copy link
Collaborator

@armleo Can you confirm is the merge-window-3 latest one or merge-windows-4 is latest?

@donn
Copy link
Collaborator

donn commented Sep 6, 2022

I spent entirely too much time copywriting mw3. You'll have to rebase mw4 and open a new PR.

@donn donn merged commit 826bb8f into The-OpenROAD-Project:master Sep 6, 2022
This was referenced Sep 9, 2022
@armleo armleo mentioned this pull request Sep 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants