Skip to content

Documentation Improvements #199

@gpauloski

Description

@gpauloski

Describe the Request

Now that we've migrated to MKDocs, there are some things that could be improved but I delayed working on to make sure the migration worked.

  • Make the headers in the docstrings more apparent (bold, use section separators, etc.)
  • Use full member paths in docstring headers.
    • Won't work because black can't format the separate docstrings with the full path.
  • Adjust tabs at top of the page to match other projects.
    • Home
      • Overview
      • Installation
      • Getting Started
      • Examples
      • Changelog
    • Concepts
      • Proxy
      • Store
      • Connector
    • Guides
    • Developing
    • API Documentation
      • Legacy Docs
      • Known Issues
    • Changelog
  • Add links on doc pages to github source. Maybe by editing here:
    fd.write(f'::: {parts[-1]}')
  • Add edit links on regular markdown pages.
  • Copyright GLabs and link to GLabs in footer
  • Fix typo in legacy versions
  • Fix incorrect docs link in README.
  • Open external links in new tab
  • Update doc url in pyproject.toml (and grep for any lingering rtd links)
    • Make "homepage" proxystore.dev so if we every add a homepage there it's correct.
    • Update "extensions" package similarly.
  • Link to extensions repo/docs
  • Typo in home_dir() in https://docs.proxystore.dev/main/reference/store/endpoint/#proxystore.store.endpoint.EndpointStore
  • Move main to top of list in versions on docs
  • Remove 0.4.0 from gh-pages branch as it's not correct
  • Add more module level descriptors.
  • Include proxystore inventory on proxystore-extensions.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation or examples

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions