Skip to content
This repository has been archived by the owner on Mar 26, 2024. It is now read-only.

Update docs/wiki #23

Open
4 tasks
Ma27 opened this issue Aug 11, 2019 · 0 comments
Open
4 tasks

Update docs/wiki #23

Ma27 opened this issue Aug 11, 2019 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@Ma27
Copy link
Member

Ma27 commented Aug 11, 2019

It occurred to me that some parts of the development pages in the Wiki are slightly outdated (which is at least partly my fault as I didn't write some documentation about cargo-workspaces and cargo-make yet).

I'd go through the wiki and readme pages in the repository during the next days to fix/improve the following aspects:

  • More details about project structure (e.g. how to build?, how to create a new crate?, when to add further tasks?, how to update the rust channel for everybody?, etc.)
  • Reread the Git proposal (it's actually way too long and could be shortened before a decision about incorporating the proposal can be taken)
  • Update frontend docs (build with cargo-make, common pitfalls (e.g. conflicting stack pointers), probably sub-pages about the history of the shared-memory implementation)
  • Basic documentation about tools and math helpers (at least basic descriptions and simple usage examples)
@Ma27 Ma27 added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Aug 11, 2019
@Ma27 Ma27 self-assigned this Aug 11, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant