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

rm -rf docs #773

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

rm -rf docs #773

wants to merge 2 commits into from

Conversation

david415
Copy link
Member

@david415 david415 commented Nov 3, 2024

moved the docs to our "website" repo

moved the docs to our "website" repo
@leif
Copy link
Member

leif commented Nov 4, 2024

why though?

I think it is better to keep the docs in the monorepo, for reasons I explained in chat but will summarize here:

  • it makes it easier to keep docs in sync with code, and thus more likely that we will
  • when there are long-lived feature branches which necessitate docs changes, it is helpful to have appropriate versions of the docs existing on those branches.
  • having a corresponding branch in a different repo would be more work, and i think makes it less likely that developers will keep docs up to date when they change things
  • when looking at an old tag of the software, one automatically gets the corresponding version of the docs from that time

@david415 i recall you agreeing with me about these benefits when we had this discussion in the past, and if i ever heard a good counter-argument i don't recall what it was. can you refresh my memory? why do you want to do this?

@david415
Copy link
Member Author

david415 commented Nov 4, 2024

why though?

While ALL of your reasons are still valid none of them are more important than our fundamental goals of delivering software and educational materials to the world, so that hopefully one day people can communicate more freely.
With all the bike shedding it becomes easy to forget our mission. Think of the abortion clinics and journalists.

Right now, before we fix our pandoc github CI issues we need a place to put PDFs, and that place has been designated as the "website" repo which by the way is where we've been hosting PDFs for over a year now.

This will also make it easy to review the docs, no?

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.

2 participants