Skip to content

Make docs website more visible #519

Closed
Closed

Description

@prestoncabe

We should make it easy to find the docs website. I assume this means adding links to both the main web page (bdtoolkit.org) and the repo/README.

Extra credit: go ahead and make the docs site a subdomain of bdtoolkit.org (along with the builder web app... though this could be a separate issue)

Note: I believe that the docs site used to be linked from the main website, but the link was removed in a recent design refresh?

Activity

  1. added
    documentationImprovements or additions to documentation
    quick winSomething with big impact for little effort
    Good for newcomerHelps new volunteers find their first issue to work on
    on Sep 27, 2026
  2. added theissue type on Sep 27, 2026
  3. earth-walker commented on Oct 5, 2026

    @earth-walker
    Collaborator

    I agree, had an issue finding the site recently until I remembered I had it bookmarked.

    I can add it back into the website if we think it would be useful for newcomers to look at. I'm mixed on that but it can't hurt I guess.

    We should definitely have a link in the main github readme.

  4. self-assigned this
    on Oct 5, 2026
  5. prestoncabe commented on Oct 6, 2026

    @prestoncabe
    CollaboratorAuthor

    @earth-walker

    I can add it back into the website if we think it would be useful for newcomers to look at. I'm mixed on that but it can't hurt I guess.

    There isn't an obvious place to put it within the layout, but I definitely think it should be somewhere. Perhaps not very useful (yet) for the non-technical folks, but it's still something that I believe should be standard for a project like ours website!

    Many open-source projects have a "Docs" link in the nav bar. Not sure what would be best, but I'd appreciate having you take a think on it and draft a PR!

  6. moved this to In progress in BDTon Oct 12, 2026
  7. moved this from In progress to In review in BDTon Oct 12, 2026
  8. moved this from In review to Done in BDTon Oct 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Good for newcomerHelps new volunteers find their first issue to work ondocumentationImprovements or additions to documentationquick winSomething with big impact for little effort

Type

Projects

  • Status
    Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions