Skip to content
This repository has been archived by the owner on Aug 30, 2022. It is now read-only.

cleanup README files #362

Merged
merged 2 commits into from Apr 6, 2020
Merged

cleanup README files #362

merged 2 commits into from Apr 6, 2020

Conversation

little-dude
Copy link
Contributor

  • use a separate README for the repo and for readthedocs
  • remove the implementation details from the repo's main README. That
    part of the documentation belong to the Rust documentation and was
    slightly outdated anyway
  • remove the keras example README, which was outdated and redundant
    with the instructions in the repo's README

@little-dude little-dude mentioned this pull request Apr 6, 2020
Merged
Robert-Steiner
Robert-Steiner approved these changes Apr 6, 2020
View reviewed changes
Copy link
Contributor

@Robert-Steiner Robert-Steiner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me
I'm just not sure if we should have two separate READMEs. Personally I prefer that both are the same.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@little-dude
cleanup README files
60cd2eb 
- use a separate README for the repo and for readthedocs
- remove the implementation details from the repo's main README. That
  part of the documentation belong to the Rust documentation and was
  slightly outdated anyway
- remove the keras example README, which was outdated and redundant
  with the instructions in the repo's README
@little-dude
Copy link
Contributor Author

I'm just not sure if we should have two separate READMEs. Personally I prefer that both are the same.

It would be nice not to duplicate anything I agree. But where should the instructions for compiling and troubleshooting go then? I think they belong to the repo, while xain-fl.readthedocs.io should be a sort of entrypoint for our documentation, that just points to the relevant resource for each area (SDK, API, backend, whitepaper, etc.)

@little-dude
Copy link
Contributor Author

Maybe the README at the root of the repo should start with a link to xain-fl.readthedocs.io, and then contain the instructions for the repo, instead of repeating what's in docs/README.md?

@little-dude
Copy link
Contributor Author

@Robert-Steiner what do you think of that last commit that moves the repo specific instructions to a CONTRIBUTING.md, and adds a direct link to the rtd doc? Just a suggestion.

@Robert-Steiner
Copy link
Contributor

I like that
What do you think @janpetschexain @finiteprods @rsaffi ?

@janpetschexain
Copy link
Contributor

I like that
What do you think @janpetschexain @finiteprods @rsaffi ?

me too

@Robert-Steiner
Copy link
Contributor

But I'm totally fine going with the first version

@finiteprods
Copy link
Contributor

Yeah I’m in favour of providing a link over repeating ourselves 👍

@little-dude
Copy link
Contributor Author

I don't mind either way, so if you have even a slight preference for the CONTRIBUTING.md version let's go with that :)

@little-dude little-dude merged commit 3cef71a into PB-558-provide-swagger-as-markdown Apr 6, 2020
@little-dude little-dude deleted the cleanup-readme branch April 6, 2020 13:00
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@Robert-Steiner Robert-Steiner Robert-Steiner approved these changes

@janpetschexain janpetschexain janpetschexain approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@little-dude @Robert-Steiner @janpetschexain @finiteprods