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

Mark online documentation unstable #72

Merged
merged 1 commit into from
Oct 18, 2024
Merged

Conversation

Pennycook
Copy link
Contributor

Related issues

N/A

Proposed changes

  • Add a warning to the main page that the documentation should be considered unstable.

@swright87 had previously complained that the documentation didn't reflect that latest functionality. The idea of the change in this PR is to make it clear that the online documentation is unstable, allowing us to push the latest changes to the live website ahead of the P3 Tooling panel at P3HPC.

@Pennycook Pennycook added the documentation Improvements or additions to documentation label Oct 10, 2024
@Pennycook Pennycook mentioned this pull request Oct 10, 2024
3 tasks
Copy link
Collaborator

@swright87 swright87 left a comment

Choose a reason for hiding this comment

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

I think this is a reasonable approach :)

@Pennycook Pennycook merged commit 71da3e8 into intel:main Oct 18, 2024
3 checks passed
@Pennycook Pennycook deleted the unstable-docs branch October 18, 2024 08:58
Pennycook added a commit that referenced this pull request Oct 18, 2024
- Switches to furo theme (#47)
- Updates examples to new style (#51, #67)
- Adds new examples (#54, #55, #58)
- Marks the documentation unstable (#72)

Signed-off-by: John Pennycook <[email protected]>
@Pennycook
Copy link
Contributor Author

@swright87, @laserkelvin: The latest documentation is now live at https://intel.github.io/p3-analysis-library/. I'd appreciate it if you could take a quick look at it, just to make sure that we haven't accidentally missed something that only shows up in the HTML render of the documentation.

@swright87
Copy link
Collaborator

From a 10 minute glance through it all looks great to me. Didn't notice anything worthy of attention. 👍

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.

3 participants