Skip to content

Conversation

@harveydevereux
Copy link
Collaborator

Couple of minor issues one typo in install instructions, but also some dead links to the getting started guide.

Closes #624

@ElliottKasoar
Copy link
Member

Can you check the getting started section of the online docs too? I think the extras typo was there too, but I wouldn't be surprised if any links are similarly out of date.

@ElliottKasoar ElliottKasoar added the documentation Improvements or additions to documentation label Nov 12, 2025
@harveydevereux
Copy link
Collaborator Author

Can you check the getting started section of the online docs too? I think the extras typo was there too, but I wouldn't be surprised if any links are similarly out of date.

Oh yes forgot about that, I did click all the readme links. Could well be some hiding.

@harveydevereux
Copy link
Collaborator Author

Actually @ElliottKasoar does it need to be uv sync --extra all? Not uv sync --extra [extra]?

I guess the last one was you saying the general case: [extra] gets replaced by something. Is it still all that we want there?

@ElliottKasoar
Copy link
Member

Actually @ElliottKasoar does it need to be uv sync --extra all? Not uv sync --extra [extra]?

I guess the last one was you saying the general case: [extra] gets replaced by something. Is it still all that we want there?

I think you can argue either way. I'd be inclined to revert back to all since the tests depend on MACE for the most part.

alinelena
alinelena previously approved these changes Nov 15, 2025
@harveydevereux
Copy link
Collaborator Author

Now uv sync --extra all, and in docs too. I think that is all of them.

@alinelena alinelena merged commit 313c7f5 into stfc:main Nov 17, 2025
8 of 11 checks passed
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.

Development install instructions typo?

3 participants