Skip to content

Update website structure and project metadata#37

Merged
sfmig merged 10 commits intomainfrom
update-website
Mar 26, 2026
Merged

Update website structure and project metadata#37
sfmig merged 10 commits intomainfrom
update-website

Conversation

@niksirbi
Copy link
Copy Markdown
Member

@niksirbi niksirbi commented Mar 26, 2026

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?

Our website was very barebones, with almost no information about the project (beyond the benchmark dataset spec).

What does this PR do?

Overhauls the README, the website and project metadata. Specifically:

  • Updated project metadata in pyproject.toml (description, authors, URLs)
  • Updated copyright and authorship in Sphinx conf,py to "The poseinterface developers"
  • Converted docs landing page from RST to MyST markdown with sphinx-design grid cards
  • Added "About" section with sub-pages: Mission, Team, License, Code of Conduct
  • Added a minimal Contributing guide (docs/source/contributing.md) with dev setup, contribution workflow (links to movment for now), testing, linting, and CI
  • Renamed benchmark spec page from project_structure to benchmark-dataset
  • Added custom myst_url_schemes in conf.py
  • Unified project description and mission across README, docs homepage, and mission page

References

Closes #12.

How has this PR been tested?

Local documentation build. I suggest testing it in the same way.

Is this a breaking change?

No.

Does this PR require an update to the documentation?

N/A

Checklist:

  • The code has been tested locally
  • Tests have been added to cover all new functionality
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

@niksirbi niksirbi changed the title add authors and description to pyproject.toml Update website structure and project metadata Mar 26, 2026
@niksirbi niksirbi marked this pull request as ready for review March 26, 2026 18:09
@niksirbi niksirbi requested a review from sfmig March 26, 2026 18:09
@niksirbi niksirbi linked an issue Mar 26, 2026 that may be closed by this pull request
3 tasks
Copy link
Copy Markdown
Member

@sfmig sfmig left a comment

Choose a reason for hiding this comment

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

Thanks @niksirbi it looks great! Will merge now

@@ -1 +1,32 @@
[![License](https://img.shields.io/badge/License-BSD_3--Clause-orange.svg)](https://opensource.org/licenses/BSD-3-Clause)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

badges! 🤩

@sfmig sfmig merged commit 7349d05 into main Mar 26, 2026
24 checks passed
@sfmig sfmig deleted the update-website branch March 26, 2026 19:30
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.

Publish a minimal documentation website

2 participants