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

add new backBehavior doc #364

Closed
wants to merge 1 commit into
base: source
from

Conversation

Projects
None yet
4 participants
@slorber
Copy link
Member

slorber commented Feb 14, 2019

Hi,

Adding new switch router backBehavior to doc

Note really sure to understand how the docs versionning works. If there are versionned docs, what's the effect of modifying the undervsionned doc?

Do not merge yet, there are multiple places this must be documented. Just want to ask about the versionning system before completing the PR

@react-navigation-bot

This comment has been minimized.

Copy link

react-navigation-bot commented Feb 14, 2019

Deploy preview for react-navigation ready!

Built with commit 471dc5a

https://deploy-preview-364--react-navigation.netlify.com

@vonovak

This comment has been minimized.

Copy link
Collaborator

vonovak commented Feb 14, 2019

hi @slorber regarding the versioning - does the PR template help? (https://github.com/react-navigation/react-navigation.github.io/blob/source/.github/PULL_REQUEST_TEMPLATE.md) or do you find it's lacking some information?

@slorber

This comment has been minimized.

Copy link
Member Author

slorber commented Feb 14, 2019

@vonovak actually it was just warning me that I was probably doing something wrong, but it didn't really help me understand what to do exactly to do the right things. :)

What I understand is that maybe you expect users to modify v3 only? or default only? or both? or maybe v2/v3/default if the change does apply to v2 too? Not sure to understand how the merging happens afterward. If I need to modify v3, why should I need to modify default file too? Is default file for next version v4?

There's something unclear to me in this process, but one thing I know is that contributing doc should be easy and straightforward for anyone, and it would be helpful to avoid having to fork/clone/sync with upstream/PR to just being able to contribute a doc fix properly, and keep a workflow based on simple online markdown editing.

@slorber

This comment has been minimized.

Copy link
Member Author

slorber commented Feb 28, 2019

Hi @vonovak

In the case of current new feature, should I modify:

  • docs/material-top-tab-navigator.md
  • website/versioned_docs/version-3.x/material-top-tab-navigator.md

Should I modify both? Should I modify the first? The second? (+ all other related tab nav files)

is docs/material-top-tab-navigator.md the draft for v4?

@brentvatne

This comment has been minimized.

Copy link
Member

brentvatne commented Mar 6, 2019

@slorber - yup, exactly

@slorber

This comment has been minimized.

Copy link
Member Author

slorber commented Mar 12, 2019

Thanks, just opened a correct PR here: #376

@slorber slorber closed this Mar 12, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.